AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.dynamodb.getGlobalTable

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getGlobalTable

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGlobalTable(args: GetGlobalTableArgs, opts?: InvokeOptions): Promise<GetGlobalTableResult>
function getGlobalTableOutput(args: GetGlobalTableOutputArgs, opts?: InvokeOptions): Output<GetGlobalTableResult>

def get_global_table(table_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetGlobalTableResult
def get_global_table_output(table_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetGlobalTableResult]

func LookupGlobalTable(ctx *Context, args *LookupGlobalTableArgs, opts ...InvokeOption) (*LookupGlobalTableResult, error)
func LookupGlobalTableOutput(ctx *Context, args *LookupGlobalTableOutputArgs, opts ...InvokeOption) LookupGlobalTableResultOutput

> Note: This function is named LookupGlobalTable in the Go SDK.

public static class GetGlobalTable 
{
    public static Task<GetGlobalTableResult> InvokeAsync(GetGlobalTableArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalTableResult> Invoke(GetGlobalTableInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGlobalTableResult> getGlobalTable(GetGlobalTableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:dynamodb:getGlobalTable
  arguments:
    # arguments dictionary

The following arguments are supported:

TableName string: A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see Name type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

TableName string: A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see Name type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

tableName String: A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see Name type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

tableName string: A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see Name type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

table_name str: A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see Name type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

tableName String: A name for the global table. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see Name type .
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

getGlobalTable Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) of the DynamoDB table, such as arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable . The ARN returned is that of the replica in the region the stack is deployed to.

AttributeDefinitions List<Pulumi.AwsNative.DynamoDb.Outputs.GlobalTableAttributeDefinition>

A list of attributes that describe the key schema for the global table and indexes.

BillingMode string

Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:

PAY_PER_REQUEST
PROVISIONED

All replicas in your global table will have the same billing mode. If you use PROVISIONED billing mode, you must provide an auto scaling configuration via the WriteProvisionedThroughputSettings property. The default value of this property is PROVISIONED .

GlobalSecondaryIndexes List<Pulumi.AwsNative.DynamoDb.Outputs.GlobalTableGlobalSecondaryIndex>

Global secondary indexes to be created on the global table. You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.

Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.

Replicas List<Pulumi.AwsNative.DynamoDb.Outputs.GlobalTableReplicaSpecification>

Specifies the list of replicas for your global table. The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in Replicas with the region us-east-1. You cannot remove the replica in the stack region.

Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.
If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.

You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.

SseSpecification Pulumi.AwsNative.DynamoDb.Outputs.GlobalTableSseSpecification

Specifies the settings to enable server-side encryption. These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the ReplicaSpecification.ReplicaSSESpecification property.

StreamArn string

The ARN of the DynamoDB stream, such as arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000 . The StreamArn returned is that of the replica in the region the stack is deployed to.

You must specify the StreamSpecification property to use this attribute.

StreamSpecification Pulumi.AwsNative.DynamoDb.Outputs.GlobalTableStreamSpecification

Specifies the streams settings on your global table. You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.

TableId string

Unique identifier for the table, such as a123b456-01ab-23cd-123a-111222aaabbb . The TableId returned is that of the replica in the region the stack is deployed to.

TimeToLiveSpecification Pulumi.AwsNative.DynamoDb.Outputs.GlobalTableTimeToLiveSpecification

Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.

WarmThroughput Pulumi.AwsNative.DynamoDb.Outputs.GlobalTableWarmThroughput

WriteOnDemandThroughputSettings Pulumi.AwsNative.DynamoDb.Outputs.GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

WriteProvisionedThroughputSettings Pulumi.AwsNative.DynamoDb.Outputs.GlobalTableWriteProvisionedThroughputSettings

Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .

Arn string

AttributeDefinitions []GlobalTableAttributeDefinition

A list of attributes that describe the key schema for the global table and indexes.

BillingMode string

Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:

PAY_PER_REQUEST
PROVISIONED

GlobalSecondaryIndexes []GlobalTableGlobalSecondaryIndex

Replicas []GlobalTableReplicaSpecification

Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.
If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.

You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.

SseSpecification GlobalTableSseSpecification

StreamArn string

You must specify the StreamSpecification property to use this attribute.

StreamSpecification GlobalTableStreamSpecification

TableId string

Unique identifier for the table, such as a123b456-01ab-23cd-123a-111222aaabbb . The TableId returned is that of the replica in the region the stack is deployed to.

TimeToLiveSpecification GlobalTableTimeToLiveSpecification

Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.

WarmThroughput GlobalTableWarmThroughput

WriteOnDemandThroughputSettings GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

WriteProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .

arn String

attributeDefinitions List<GlobalTableAttributeDefinition>

A list of attributes that describe the key schema for the global table and indexes.

billingMode String

Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:

PAY_PER_REQUEST
PROVISIONED

globalSecondaryIndexes List<GlobalTableGlobalSecondaryIndex>

replicas List<GlobalTableReplicaSpecification>

Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.
If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.

You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.

sseSpecification GlobalTableSseSpecification

streamArn String

You must specify the StreamSpecification property to use this attribute.

streamSpecification GlobalTableStreamSpecification

tableId String

Unique identifier for the table, such as a123b456-01ab-23cd-123a-111222aaabbb . The TableId returned is that of the replica in the region the stack is deployed to.

timeToLiveSpecification GlobalTableTimeToLiveSpecification

Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.

warmThroughput GlobalTableWarmThroughput

writeOnDemandThroughputSettings GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

writeProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .

arn string

attributeDefinitions GlobalTableAttributeDefinition[]

A list of attributes that describe the key schema for the global table and indexes.

billingMode string

Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:

PAY_PER_REQUEST
PROVISIONED

globalSecondaryIndexes GlobalTableGlobalSecondaryIndex[]

replicas GlobalTableReplicaSpecification[]

Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.
If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.

You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.

sseSpecification GlobalTableSseSpecification

streamArn string

You must specify the StreamSpecification property to use this attribute.

streamSpecification GlobalTableStreamSpecification

tableId string

Unique identifier for the table, such as a123b456-01ab-23cd-123a-111222aaabbb . The TableId returned is that of the replica in the region the stack is deployed to.

timeToLiveSpecification GlobalTableTimeToLiveSpecification

Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.

warmThroughput GlobalTableWarmThroughput

writeOnDemandThroughputSettings GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

writeProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .

arn str

attribute_definitions Sequence[GlobalTableAttributeDefinition]

A list of attributes that describe the key schema for the global table and indexes.

billing_mode str

Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:

PAY_PER_REQUEST
PROVISIONED

global_secondary_indexes Sequence[GlobalTableGlobalSecondaryIndex]

replicas Sequence[GlobalTableReplicaSpecification]

Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.
If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.

You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.

sse_specification GlobalTableSseSpecification

stream_arn str

You must specify the StreamSpecification property to use this attribute.

stream_specification GlobalTableStreamSpecification

table_id str

Unique identifier for the table, such as a123b456-01ab-23cd-123a-111222aaabbb . The TableId returned is that of the replica in the region the stack is deployed to.

time_to_live_specification GlobalTableTimeToLiveSpecification

Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.

warm_throughput GlobalTableWarmThroughput

write_on_demand_throughput_settings GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

write_provisioned_throughput_settings GlobalTableWriteProvisionedThroughputSettings

Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .

arn String

attributeDefinitions List<Property Map>

A list of attributes that describe the key schema for the global table and indexes.

billingMode String

Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:

PAY_PER_REQUEST
PROVISIONED

globalSecondaryIndexes List<Property Map>

replicas List<Property Map>

Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.
If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.

You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.

sseSpecification Property Map

streamArn String

You must specify the StreamSpecification property to use this attribute.

streamSpecification Property Map

tableId String

Unique identifier for the table, such as a123b456-01ab-23cd-123a-111222aaabbb . The TableId returned is that of the replica in the region the stack is deployed to.

timeToLiveSpecification Property Map

Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.

warmThroughput Property Map

writeOnDemandThroughputSettings Property Map

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

writeProvisionedThroughputSettings Property Map

Specifies an auto scaling policy for write capacity. This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .

Supporting Types

GlobalTableAttributeDefinition

AttributeName string

A name for the attribute.

AttributeType string

The data type for the attribute, where:

S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary

AttributeName string

A name for the attribute.

AttributeType string

The data type for the attribute, where:

S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary

attributeName String

A name for the attribute.

attributeType String

The data type for the attribute, where:

S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary

attributeName string

A name for the attribute.

attributeType string

The data type for the attribute, where:

S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary

attribute_name str

A name for the attribute.

attribute_type str

The data type for the attribute, where:

S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary

attributeName String

A name for the attribute.

attributeType String

The data type for the attribute, where:

S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary

GlobalTableCapacityAutoScalingSettings

MaxCapacity int

The maximum provisioned capacity units for the global table.

MinCapacity int

The minimum provisioned capacity units for the global table.

TargetTrackingScalingPolicyConfiguration Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableTargetTrackingScalingPolicyConfiguration

Defines a target tracking scaling policy.

SeedCapacity int

When switching billing mode from PAY_PER_REQUEST to PROVISIONED , DynamoDB requires you to specify read and write capacity unit values for the table and for each global secondary index. These values will be applied to all replicas. The table will use these provisioned values until CloudFormation creates the autoscaling policies you configured in your template. CloudFormation cannot determine what capacity the table and its global secondary indexes will require in this time period, since they are application-dependent.

If you want to switch a table's billing mode from PAY_PER_REQUEST to PROVISIONED , you must specify a value for this property for each autoscaled resource. If you specify different values for the same resource in different regions, CloudFormation will use the highest value found in either the SeedCapacity or ReadCapacityUnits properties. For example, if your global secondary index myGSI has a SeedCapacity of 10 in us-east-1 and a fixed ReadCapacityUnits of 20 in eu-west-1, CloudFormation will initially set the read capacity for myGSI to 20. Note that if you disable ScaleIn for myGSI in us-east-1, its read capacity units might not be set back to 10.

You must also specify a value for SeedCapacity when you plan to switch a table's billing mode from PROVISIONED to PAY_PER_REQUEST , because CloudFormation might need to roll back the operation (reverting the billing mode to PROVISIONED ) and this cannot succeed without specifying a value for SeedCapacity .

MaxCapacity int

The maximum provisioned capacity units for the global table.

MinCapacity int

The minimum provisioned capacity units for the global table.

TargetTrackingScalingPolicyConfiguration GlobalTableTargetTrackingScalingPolicyConfiguration

Defines a target tracking scaling policy.

SeedCapacity int

maxCapacity Integer

The maximum provisioned capacity units for the global table.

minCapacity Integer

The minimum provisioned capacity units for the global table.

targetTrackingScalingPolicyConfiguration GlobalTableTargetTrackingScalingPolicyConfiguration

Defines a target tracking scaling policy.

seedCapacity Integer

maxCapacity number

The maximum provisioned capacity units for the global table.

minCapacity number

The minimum provisioned capacity units for the global table.

targetTrackingScalingPolicyConfiguration GlobalTableTargetTrackingScalingPolicyConfiguration

Defines a target tracking scaling policy.

seedCapacity number

max_capacity int

The maximum provisioned capacity units for the global table.

min_capacity int

The minimum provisioned capacity units for the global table.

target_tracking_scaling_policy_configuration GlobalTableTargetTrackingScalingPolicyConfiguration

Defines a target tracking scaling policy.

seed_capacity int

maxCapacity Number

The maximum provisioned capacity units for the global table.

minCapacity Number

The minimum provisioned capacity units for the global table.

targetTrackingScalingPolicyConfiguration Property Map

Defines a target tracking scaling policy.

seedCapacity Number

GlobalTableContributorInsightsSpecification

Enabled bool: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

Enabled bool: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

enabled Boolean: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

enabled boolean: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

enabled bool: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

enabled Boolean: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).

GlobalTableGlobalSecondaryIndex

IndexName string

The name of the global secondary index. The name must be unique among all other indexes on this table.

KeySchema List<Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableKeySchema>

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

Projection Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableProjection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

WarmThroughput Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableWarmThroughput

WriteOnDemandThroughputSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

WriteProvisionedThroughputSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableWriteProvisionedThroughputSettings

Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's BillingMode is PROVISIONED . All replicas will have the same write capacity settings for this global secondary index.

IndexName string

The name of the global secondary index. The name must be unique among all other indexes on this table.

KeySchema []GlobalTableKeySchema

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

Projection GlobalTableProjection

WarmThroughput GlobalTableWarmThroughput

WriteOnDemandThroughputSettings GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

WriteProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

indexName String

The name of the global secondary index. The name must be unique among all other indexes on this table.

keySchema List<GlobalTableKeySchema>

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection GlobalTableProjection

warmThroughput GlobalTableWarmThroughput

writeOnDemandThroughputSettings GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

writeProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

indexName string

The name of the global secondary index. The name must be unique among all other indexes on this table.

keySchema GlobalTableKeySchema[]

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection GlobalTableProjection

warmThroughput GlobalTableWarmThroughput

writeOnDemandThroughputSettings GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

writeProvisionedThroughputSettings GlobalTableWriteProvisionedThroughputSettings

index_name str

The name of the global secondary index. The name must be unique among all other indexes on this table.

key_schema Sequence[GlobalTableKeySchema]

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection GlobalTableProjection

warm_throughput GlobalTableWarmThroughput

write_on_demand_throughput_settings GlobalTableWriteOnDemandThroughputSettings

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

write_provisioned_throughput_settings GlobalTableWriteProvisionedThroughputSettings

indexName String

The name of the global secondary index. The name must be unique among all other indexes on this table.

keySchema List<Property Map>

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

projection Property Map

warmThroughput Property Map

writeOnDemandThroughputSettings Property Map

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

writeProvisionedThroughputSettings Property Map

GlobalTableKeySchema

AttributeName string

The name of a key attribute.

KeyType string

The role that this key attribute will assume:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

AttributeName string

The name of a key attribute.

KeyType string

The role that this key attribute will assume:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

attributeName String

The name of a key attribute.

keyType String

The role that this key attribute will assume:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

attributeName string

The name of a key attribute.

keyType string

The role that this key attribute will assume:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

attribute_name str

The name of a key attribute.

key_type str

The role that this key attribute will assume:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

attributeName String

The name of a key attribute.

keyType String

The role that this key attribute will assume:

HASH - partition key
RANGE - sort key

The partition key of an item is also known as its hash attribute . The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

GlobalTableKinesisStreamSpecification

StreamArn string: The ARN for a specific Kinesis data stream.
ApproximateCreationDateTimePrecision Pulumi.AwsNative.DynamoDb.GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision: The precision for the time and date that the stream was created.

StreamArn string: The ARN for a specific Kinesis data stream.
ApproximateCreationDateTimePrecision GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision: The precision for the time and date that the stream was created.

streamArn String: The ARN for a specific Kinesis data stream.
approximateCreationDateTimePrecision GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision: The precision for the time and date that the stream was created.

streamArn string: The ARN for a specific Kinesis data stream.
approximateCreationDateTimePrecision GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision: The precision for the time and date that the stream was created.

stream_arn str: The ARN for a specific Kinesis data stream.
approximate_creation_date_time_precision GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision: The precision for the time and date that the stream was created.

streamArn String: The ARN for a specific Kinesis data stream.
approximateCreationDateTimePrecision "MICROSECOND" | "MILLISECOND": The precision for the time and date that the stream was created.

GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision

GlobalTablePointInTimeRecoverySpecification

PointInTimeRecoveryEnabled bool: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

PointInTimeRecoveryEnabled bool: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

pointInTimeRecoveryEnabled Boolean: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

pointInTimeRecoveryEnabled boolean: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

point_in_time_recovery_enabled bool: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

pointInTimeRecoveryEnabled Boolean: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

GlobalTableProjection

NonKeyAttributes List<string>

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

ProjectionType string

The set of attributes that are projected into the index:

KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - In addition to the attributes described in KEYS_ONLY , the secondary index will include other non-key attributes that you specify.
ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

NonKeyAttributes []string

Represents the non-key attribute names which will be projected into the index.

ProjectionType string

The set of attributes that are projected into the index:

KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - In addition to the attributes described in KEYS_ONLY , the secondary index will include other non-key attributes that you specify.
ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

nonKeyAttributes List<String>

Represents the non-key attribute names which will be projected into the index.

projectionType String

The set of attributes that are projected into the index:

KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - In addition to the attributes described in KEYS_ONLY , the secondary index will include other non-key attributes that you specify.
ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

nonKeyAttributes string[]

Represents the non-key attribute names which will be projected into the index.

projectionType string

The set of attributes that are projected into the index:

KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - In addition to the attributes described in KEYS_ONLY , the secondary index will include other non-key attributes that you specify.
ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

non_key_attributes Sequence[str]

Represents the non-key attribute names which will be projected into the index.

projection_type str

The set of attributes that are projected into the index:

KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - In addition to the attributes described in KEYS_ONLY , the secondary index will include other non-key attributes that you specify.
ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

nonKeyAttributes List<String>

Represents the non-key attribute names which will be projected into the index.

projectionType String

The set of attributes that are projected into the index:

KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - In addition to the attributes described in KEYS_ONLY , the secondary index will include other non-key attributes that you specify.
ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

GlobalTableReadOnDemandThroughputSettings

MaxReadRequestUnits int: Maximum number of read request units for the specified replica of a global table.

MaxReadRequestUnits int: Maximum number of read request units for the specified replica of a global table.

maxReadRequestUnits Integer: Maximum number of read request units for the specified replica of a global table.

maxReadRequestUnits number: Maximum number of read request units for the specified replica of a global table.

max_read_request_units int: Maximum number of read request units for the specified replica of a global table.

maxReadRequestUnits Number: Maximum number of read request units for the specified replica of a global table.

GlobalTableReadProvisionedThroughputSettings

ReadCapacityAutoScalingSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.
ReadCapacityUnits int: Specifies a fixed read capacity for the replica table or global secondary index.

ReadCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.
ReadCapacityUnits int: Specifies a fixed read capacity for the replica table or global secondary index.

readCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.
readCapacityUnits Integer: Specifies a fixed read capacity for the replica table or global secondary index.

readCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.
readCapacityUnits number: Specifies a fixed read capacity for the replica table or global secondary index.

read_capacity_auto_scaling_settings GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.
read_capacity_units int: Specifies a fixed read capacity for the replica table or global secondary index.

readCapacityAutoScalingSettings Property Map: Specifies auto scaling settings for the replica table or global secondary index.
readCapacityUnits Number: Specifies a fixed read capacity for the replica table or global secondary index.

GlobalTableReplicaGlobalSecondaryIndexSpecification

IndexName string: The name of the global secondary index. The name must be unique among all other indexes on this table.
ContributorInsightsSpecification Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableContributorInsightsSpecification: Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
ReadOnDemandThroughputSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableReadOnDemandThroughputSettings: Sets the read request settings for a replica global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .
ReadProvisionedThroughputSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableReadProvisionedThroughputSettings: Allows you to specify the read capacity settings for a replica global secondary index when the BillingMode is set to PROVISIONED .

IndexName string: The name of the global secondary index. The name must be unique among all other indexes on this table.
ContributorInsightsSpecification GlobalTableContributorInsightsSpecification: Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
ReadOnDemandThroughputSettings GlobalTableReadOnDemandThroughputSettings: Sets the read request settings for a replica global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .
ReadProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings: Allows you to specify the read capacity settings for a replica global secondary index when the BillingMode is set to PROVISIONED .

indexName String: The name of the global secondary index. The name must be unique among all other indexes on this table.
contributorInsightsSpecification GlobalTableContributorInsightsSpecification: Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
readOnDemandThroughputSettings GlobalTableReadOnDemandThroughputSettings: Sets the read request settings for a replica global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .
readProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings: Allows you to specify the read capacity settings for a replica global secondary index when the BillingMode is set to PROVISIONED .

indexName string: The name of the global secondary index. The name must be unique among all other indexes on this table.
contributorInsightsSpecification GlobalTableContributorInsightsSpecification: Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
readOnDemandThroughputSettings GlobalTableReadOnDemandThroughputSettings: Sets the read request settings for a replica global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .
readProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings: Allows you to specify the read capacity settings for a replica global secondary index when the BillingMode is set to PROVISIONED .

index_name str: The name of the global secondary index. The name must be unique among all other indexes on this table.
contributor_insights_specification GlobalTableContributorInsightsSpecification: Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
read_on_demand_throughput_settings GlobalTableReadOnDemandThroughputSettings: Sets the read request settings for a replica global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .
read_provisioned_throughput_settings GlobalTableReadProvisionedThroughputSettings: Allows you to specify the read capacity settings for a replica global secondary index when the BillingMode is set to PROVISIONED .

indexName String: The name of the global secondary index. The name must be unique among all other indexes on this table.
contributorInsightsSpecification Property Map: Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
readOnDemandThroughputSettings Property Map: Sets the read request settings for a replica global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .
readProvisionedThroughputSettings Property Map: Allows you to specify the read capacity settings for a replica global secondary index when the BillingMode is set to PROVISIONED .

GlobalTableReplicaSpecification

Region string

The region in which this replica exists.

ContributorInsightsSpecification Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.

DeletionProtectionEnabled bool

Determines if a replica is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Amazon DynamoDB Developer Guide .

GlobalSecondaryIndexes List<Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableReplicaGlobalSecondaryIndexSpecification>

Defines additional settings for the global secondary indexes of this replica.

KinesisStreamSpecification Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableKinesisStreamSpecification

Defines the Kinesis Data Streams configuration for the specified replica.

PointInTimeRecoverySpecification Pulumi.AwsNative.DynamoDb.Inputs.GlobalTablePointInTimeRecoverySpecification

The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.

ReadOnDemandThroughputSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableReadOnDemandThroughputSettings

Sets read request settings for the replica table.

ReadProvisionedThroughputSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableReadProvisionedThroughputSettings

Defines read capacity settings for the replica table.

ReplicaStreamSpecification Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableReplicaStreamSpecification

Represents the DynamoDB Streams configuration for a global table replica.

ResourcePolicy Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableResourcePolicy

A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.

In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .

SseSpecification Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableReplicaSseSpecification

Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.

TableClass string

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

Tags List<Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableTag>

An array of key-value pairs to apply to this replica.

For more information, see Tag .

Region string

The region in which this replica exists.

ContributorInsightsSpecification GlobalTableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.

DeletionProtectionEnabled bool

GlobalSecondaryIndexes []GlobalTableReplicaGlobalSecondaryIndexSpecification

Defines additional settings for the global secondary indexes of this replica.

KinesisStreamSpecification GlobalTableKinesisStreamSpecification

Defines the Kinesis Data Streams configuration for the specified replica.

PointInTimeRecoverySpecification GlobalTablePointInTimeRecoverySpecification

The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.

ReadOnDemandThroughputSettings GlobalTableReadOnDemandThroughputSettings

Sets read request settings for the replica table.

ReadProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings

Defines read capacity settings for the replica table.

ReplicaStreamSpecification GlobalTableReplicaStreamSpecification

Represents the DynamoDB Streams configuration for a global table replica.

ResourcePolicy GlobalTableResourcePolicy

SseSpecification GlobalTableReplicaSseSpecification

Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.

TableClass string

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

Tags []GlobalTableTag

An array of key-value pairs to apply to this replica.

For more information, see Tag .

region String

The region in which this replica exists.

contributorInsightsSpecification GlobalTableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.

deletionProtectionEnabled Boolean

globalSecondaryIndexes List<GlobalTableReplicaGlobalSecondaryIndexSpecification>

Defines additional settings for the global secondary indexes of this replica.

kinesisStreamSpecification GlobalTableKinesisStreamSpecification

Defines the Kinesis Data Streams configuration for the specified replica.

pointInTimeRecoverySpecification GlobalTablePointInTimeRecoverySpecification

The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.

readOnDemandThroughputSettings GlobalTableReadOnDemandThroughputSettings

Sets read request settings for the replica table.

readProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings

Defines read capacity settings for the replica table.

replicaStreamSpecification GlobalTableReplicaStreamSpecification

Represents the DynamoDB Streams configuration for a global table replica.

resourcePolicy GlobalTableResourcePolicy

sseSpecification GlobalTableReplicaSseSpecification

Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.

tableClass String

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

tags List<GlobalTableTag>

An array of key-value pairs to apply to this replica.

For more information, see Tag .

region string

The region in which this replica exists.

contributorInsightsSpecification GlobalTableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.

deletionProtectionEnabled boolean

globalSecondaryIndexes GlobalTableReplicaGlobalSecondaryIndexSpecification[]

Defines additional settings for the global secondary indexes of this replica.

kinesisStreamSpecification GlobalTableKinesisStreamSpecification

Defines the Kinesis Data Streams configuration for the specified replica.

pointInTimeRecoverySpecification GlobalTablePointInTimeRecoverySpecification

The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.

readOnDemandThroughputSettings GlobalTableReadOnDemandThroughputSettings

Sets read request settings for the replica table.

readProvisionedThroughputSettings GlobalTableReadProvisionedThroughputSettings

Defines read capacity settings for the replica table.

replicaStreamSpecification GlobalTableReplicaStreamSpecification

Represents the DynamoDB Streams configuration for a global table replica.

resourcePolicy GlobalTableResourcePolicy

sseSpecification GlobalTableReplicaSseSpecification

Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.

tableClass string

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

tags GlobalTableTag[]

An array of key-value pairs to apply to this replica.

For more information, see Tag .

region str

The region in which this replica exists.

contributor_insights_specification GlobalTableContributorInsightsSpecification

The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.

deletion_protection_enabled bool

global_secondary_indexes Sequence[GlobalTableReplicaGlobalSecondaryIndexSpecification]

Defines additional settings for the global secondary indexes of this replica.

kinesis_stream_specification GlobalTableKinesisStreamSpecification

Defines the Kinesis Data Streams configuration for the specified replica.

point_in_time_recovery_specification GlobalTablePointInTimeRecoverySpecification

The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.

read_on_demand_throughput_settings GlobalTableReadOnDemandThroughputSettings

Sets read request settings for the replica table.

read_provisioned_throughput_settings GlobalTableReadProvisionedThroughputSettings

Defines read capacity settings for the replica table.

replica_stream_specification GlobalTableReplicaStreamSpecification

Represents the DynamoDB Streams configuration for a global table replica.

resource_policy GlobalTableResourcePolicy

sse_specification GlobalTableReplicaSseSpecification

Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.

table_class str

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

tags Sequence[GlobalTableTag]

An array of key-value pairs to apply to this replica.

For more information, see Tag .

region String

The region in which this replica exists.

contributorInsightsSpecification Property Map

The settings used to enable or disable CloudWatch Contributor Insights for the specified replica. When not specified, defaults to contributor insights disabled for the replica.

deletionProtectionEnabled Boolean

globalSecondaryIndexes List<Property Map>

Defines additional settings for the global secondary indexes of this replica.

kinesisStreamSpecification Property Map

Defines the Kinesis Data Streams configuration for the specified replica.

pointInTimeRecoverySpecification Property Map

The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.

readOnDemandThroughputSettings Property Map

Sets read request settings for the replica table.

readProvisionedThroughputSettings Property Map

Defines read capacity settings for the replica table.

replicaStreamSpecification Property Map

Represents the DynamoDB Streams configuration for a global table replica.

resourcePolicy Property Map

sseSpecification Property Map

Allows you to specify a customer-managed key for the replica. When using customer-managed keys for server-side encryption, this property must have a value in all replicas.

tableClass String

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

tags List<Property Map>

An array of key-value pairs to apply to this replica.

For more information, see Tag .

GlobalTableReplicaSseSpecification

KmsMasterKeyId string: The AWS KMS key that should be used for the AWS KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb .

KmsMasterKeyId string: The AWS KMS key that should be used for the AWS KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb .

kmsMasterKeyId String: The AWS KMS key that should be used for the AWS KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb .

kmsMasterKeyId string: The AWS KMS key that should be used for the AWS KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb .

kms_master_key_id str: The AWS KMS key that should be used for the AWS KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb .

kmsMasterKeyId String: The AWS KMS key that should be used for the AWS KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb .

GlobalTableReplicaStreamSpecification

ResourcePolicy Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableResourcePolicy

A resource-based policy document that contains the permissions for the specified stream of a DynamoDB global table replica. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.

You can update the ResourcePolicy property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.

ResourcePolicy GlobalTableResourcePolicy

You can update the ResourcePolicy property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.

resourcePolicy GlobalTableResourcePolicy

You can update the ResourcePolicy property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.

resourcePolicy GlobalTableResourcePolicy

You can update the ResourcePolicy property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.

resource_policy GlobalTableResourcePolicy

You can update the ResourcePolicy property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.

resourcePolicy Property Map

You can update the ResourcePolicy property if you've specified more than one table using the AWS ::DynamoDB::GlobalTable resource.

GlobalTableResourcePolicy

PolicyDocument object: A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .

PolicyDocument interface{}: A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .

policyDocument Object: A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .

policyDocument any: A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .

policy_document Any: A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .

policyDocument Any: A resource-based policy document that contains permissions to add to the specified DynamoDB table, its indexes, and stream. In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .

GlobalTableSseSpecification

SseEnabled bool

Indicates whether server-side encryption is performed using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used ( AWS KMS charges apply). If disabled (false) or not specified,server-side encryption is set to an AWS owned key. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the ReplicaSpecification.SSESpecification object. You cannot mix AWS managed and customer managed KMS keys.

SseType string

Server-side encryption type. The only supported value is:

KMS - Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).

SseEnabled bool

SseType string

Server-side encryption type. The only supported value is:

KMS - Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).

sseEnabled Boolean

sseType String

Server-side encryption type. The only supported value is:

KMS - Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).

sseEnabled boolean

sseType string

Server-side encryption type. The only supported value is:

KMS - Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).

sse_enabled bool

sse_type str

Server-side encryption type. The only supported value is:

KMS - Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).

sseEnabled Boolean

sseType String

Server-side encryption type. The only supported value is:

KMS - Server-side encryption that uses AWS Key Management Service . The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).

GlobalTableStreamSpecification

StreamViewType string

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

StreamViewType string

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

streamViewType String

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

streamViewType string

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

stream_view_type str

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

streamViewType String

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

GlobalTableTag

Key string: The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
Value string: The value of the tag. Tag values are case-sensitive and can be null.

Key string: The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
Value string: The value of the tag. Tag values are case-sensitive and can be null.

key String: The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
value String: The value of the tag. Tag values are case-sensitive and can be null.

key string: The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
value string: The value of the tag. Tag values are case-sensitive and can be null.

key str: The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
value str: The value of the tag. Tag values are case-sensitive and can be null.

key String: The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
value String: The value of the tag. Tag values are case-sensitive and can be null.

GlobalTableTargetTrackingScalingPolicyConfiguration

TargetValue double: Defines a target value for the scaling policy.
DisableScaleIn bool: Indicates whether scale in by the target tracking scaling policy is disabled. The default value is false .
ScaleInCooldown int: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
ScaleOutCooldown int: The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.

TargetValue float64: Defines a target value for the scaling policy.
DisableScaleIn bool: Indicates whether scale in by the target tracking scaling policy is disabled. The default value is false .
ScaleInCooldown int: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
ScaleOutCooldown int: The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.

targetValue Double: Defines a target value for the scaling policy.
disableScaleIn Boolean: Indicates whether scale in by the target tracking scaling policy is disabled. The default value is false .
scaleInCooldown Integer: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
scaleOutCooldown Integer: The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.

targetValue number: Defines a target value for the scaling policy.
disableScaleIn boolean: Indicates whether scale in by the target tracking scaling policy is disabled. The default value is false .
scaleInCooldown number: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
scaleOutCooldown number: The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.

target_value float: Defines a target value for the scaling policy.
disable_scale_in bool: Indicates whether scale in by the target tracking scaling policy is disabled. The default value is false .
scale_in_cooldown int: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
scale_out_cooldown int: The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.

targetValue Number: Defines a target value for the scaling policy.
disableScaleIn Boolean: Indicates whether scale in by the target tracking scaling policy is disabled. The default value is false .
scaleInCooldown Number: The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
scaleOutCooldown Number: The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.

GlobalTableTimeToLiveSpecification

Enabled bool

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

AttributeName string

The name of the attribute used to store the expiration time for items in the table.

Currently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed.

Enabled bool

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

AttributeName string

The name of the attribute used to store the expiration time for items in the table.

enabled Boolean

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

attributeName String

The name of the attribute used to store the expiration time for items in the table.

enabled boolean

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

attributeName string

The name of the attribute used to store the expiration time for items in the table.

enabled bool

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

attribute_name str

The name of the attribute used to store the expiration time for items in the table.

enabled Boolean

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

attributeName String

The name of the attribute used to store the expiration time for items in the table.

ReadUnitsPerSecond int
WriteUnitsPerSecond int

readUnitsPerSecond Integer
writeUnitsPerSecond Integer

readUnitsPerSecond number
writeUnitsPerSecond number

read_units_per_second int
write_units_per_second int

readUnitsPerSecond Number
writeUnitsPerSecond Number

GlobalTableWriteOnDemandThroughputSettings

MaxWriteRequestUnits int: Maximum number of write request settings for the specified replica of a global table.

MaxWriteRequestUnits int: Maximum number of write request settings for the specified replica of a global table.

maxWriteRequestUnits Integer: Maximum number of write request settings for the specified replica of a global table.

maxWriteRequestUnits number: Maximum number of write request settings for the specified replica of a global table.

max_write_request_units int: Maximum number of write request settings for the specified replica of a global table.

maxWriteRequestUnits Number: Maximum number of write request settings for the specified replica of a global table.

GlobalTableWriteProvisionedThroughputSettings

WriteCapacityAutoScalingSettings Pulumi.AwsNative.DynamoDb.Inputs.GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.

WriteCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.

writeCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.

writeCapacityAutoScalingSettings GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.

write_capacity_auto_scaling_settings GlobalTableCapacityAutoScalingSettings: Specifies auto scaling settings for the replica table or global secondary index.

writeCapacityAutoScalingSettings Property Map: Specifies auto scaling settings for the replica table or global secondary index.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.dynamodb.getGlobalTable

On this page

On this page

Using getGlobalTable

getGlobalTable Result

Supporting Types

GlobalTableAttributeDefinition

GlobalTableCapacityAutoScalingSettings

GlobalTableContributorInsightsSpecification

GlobalTableGlobalSecondaryIndex

GlobalTableKeySchema

GlobalTableKinesisStreamSpecification

GlobalTableKinesisStreamSpecificationApproximateCreationDateTimePrecision

GlobalTablePointInTimeRecoverySpecification

GlobalTableProjection

GlobalTableReadOnDemandThroughputSettings

GlobalTableReadProvisionedThroughputSettings

GlobalTableReplicaGlobalSecondaryIndexSpecification

GlobalTableReplicaSpecification

GlobalTableReplicaSseSpecification

GlobalTableReplicaStreamSpecification

GlobalTableResourcePolicy

GlobalTableSseSpecification

GlobalTableStreamSpecification

GlobalTableTag

GlobalTableTargetTrackingScalingPolicyConfiguration

GlobalTableTimeToLiveSpecification

GlobalTableWarmThroughput

GlobalTableWriteOnDemandThroughputSettings

GlobalTableWriteProvisionedThroughputSettings

Package Details

On this page

On this page