

This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::DynamoDB::GlobalTable
<a name="aws-resource-dynamodb-globaltable"></a>

The `AWS::DynamoDB::GlobalTable` resource enables you to create and manage a Version 2019.11.21 global table. This resource cannot be used to create or manage a Version 2017.11.29 global table. For more information, see [Global tables](https://docs.aws.amazon.com//amazondynamodb/latest/developerguide/GlobalTables.html).

**Important**  
You cannot convert a resource of type `AWS::DynamoDB::Table` into a resource of type `AWS::DynamoDB::GlobalTable` by changing its type in your template. **Doing so might result in the deletion of your DynamoDB table.**  
You can instead use the GlobalTable resource to create a new table in a single Region. This will be billed the same as a single Region table. If you later update the stack to add other Regions then Global Tables pricing will apply.

You should be aware of the following behaviors when working with DynamoDB global tables.
+ The IAM Principal executing the stack operation must have the permissions listed below in all regions where you plan to have a global table replica. The IAM Principal's permissions should not have restrictions based on IP source address. Some global tables operations (for example, adding a replica) are asynchronous, and require that the IAM Principal is valid until they complete. You should not delete the Principal (user or IAM role) until CloudFormation has finished updating your stack.
  +  `application-autoscaling:DeleteScalingPolicy` 
  +  `application-autoscaling:DeleteScheduledAction` 
  +  `application-autoscaling:DeregisterScalableTarget` 
  +  `application-autoscaling:DescribeScalableTargets` 
  +  `application-autoscaling:DescribeScalingPolicies` 
  +  `application-autoscaling:PutScalingPolicy` 
  +  `application-autoscaling:PutScheduledAction` 
  +  `application-autoscaling:RegisterScalableTarget` 
  +  `dynamodb:BatchWriteItem` 
  +  `dynamodb:CreateGlobalTableWitness` 
  +  `dynamodb:CreateTable` 
  +  `dynamodb:CreateTableReplica` 
  +  `dynamodb:DeleteGlobalTableWitness` 
  +  `dynamodb:DeleteItem` 
  +  `dynamodb:DeleteTable` 
  +  `dynamodb:DeleteTableReplica` 
  +  `dynamodb:DescribeContinuousBackups` 
  +  `dynamodb:DescribeContributorInsights` 
  +  `dynamodb:DescribeTable` 
  +  `dynamodb:DescribeTableReplicaAutoScaling` 
  +  `dynamodb:DescribeTimeToLive` 
  +  `dynamodb:DisableKinesisStreamingDestination` 
  +  `dynamodb:EnableKinesisStreamingDestination` 
  +  `dynamodb:GetItem` 
  +  `dynamodb:ListTables` 
  +  `dynamodb:ListTagsOfResource` 
  +  `dynamodb:PutItem` 
  +  `dynamodb:Query` 
  +  `dynamodb:Scan` 
  +  `dynamodb:TagResource` 
  +  `dynamodb:UntagResource` 
  +  `dynamodb:UpdateContinuousBackups` 
  +  `dynamodb:UpdateContributorInsights` 
  +  `dynamodb:UpdateItem` 
  +  `dynamodb:UpdateTable` 
  +  `dynamodb:UpdateTableReplicaAutoScaling` 
  +  `dynamodb:UpdateTimeToLive` 
  +  `iam:CreateServiceLinkedRole` 
  +  `kms:CreateGrant` 
  +  `kms:DescribeKey` 
+ When using provisioned billing mode, CloudFormation will create an auto scaling policy on each of your replicas to control their write capacities. You must configure this policy using the `WriteProvisionedThroughputSettings` property. CloudFormation will ensure that all replicas have the same write capacity auto scaling property. You cannot directly specify a value for write capacity for a global table.
+ If your table uses provisioned capacity, you must configure auto scaling directly in the `AWS::DynamoDB::GlobalTable` resource. You should not configure additional auto scaling policies on any of the table replicas or global secondary indexes, either via API or via `AWS::ApplicationAutoScaling::ScalableTarget` or `AWS::ApplicationAutoScaling::ScalingPolicy`. Doing so might result in unexpected behavior and is unsupported.
+ In AWS CloudFormation, each global table is controlled by a single stack, in a single region, regardless of the number of replicas. When you deploy your template, CloudFormation will create/update all replicas as part of a single stack operation. You should not deploy the same `AWS::DynamoDB::GlobalTable` resource in multiple regions. Doing so will result in errors, and is unsupported. If you deploy your application template in multiple regions, you can use conditions to only create the resource in a single region. Alternatively, you can choose to define your `AWS::DynamoDB::GlobalTable` resources in a stack separate from your application stack, and make sure it is only deployed to a single region.

## Syntax
<a name="aws-resource-dynamodb-globaltable-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-dynamodb-globaltable-syntax.json"></a>

```
{
  "Type" : "AWS::DynamoDB::GlobalTable",
  "Properties" : {
      "[AttributeDefinitions](#cfn-dynamodb-globaltable-attributedefinitions)" : [ AttributeDefinition, ... ],
      "[BillingMode](#cfn-dynamodb-globaltable-billingmode)" : String,
      "[GlobalSecondaryIndexes](#cfn-dynamodb-globaltable-globalsecondaryindexes)" : [ GlobalSecondaryIndex, ... ],
      "[GlobalTableSourceArn](#cfn-dynamodb-globaltable-globaltablesourcearn)" : String,
      "[GlobalTableWitnesses](#cfn-dynamodb-globaltable-globaltablewitnesses)" : [ GlobalTableWitness, ... ],
      "[KeySchema](#cfn-dynamodb-globaltable-keyschema)" : [ KeySchema, ... ],
      "[LocalSecondaryIndexes](#cfn-dynamodb-globaltable-localsecondaryindexes)" : [ LocalSecondaryIndex, ... ],
      "[MultiRegionConsistency](#cfn-dynamodb-globaltable-multiregionconsistency)" : String,
      "[ReadOnDemandThroughputSettings](#cfn-dynamodb-globaltable-readondemandthroughputsettings)" : ReadOnDemandThroughputSettings,
      "[ReadProvisionedThroughputSettings](#cfn-dynamodb-globaltable-readprovisionedthroughputsettings)" : GlobalReadProvisionedThroughputSettings,
      "[Replicas](#cfn-dynamodb-globaltable-replicas)" : [ ReplicaSpecification, ... ],
      "[SSESpecification](#cfn-dynamodb-globaltable-ssespecification)" : SSESpecification,
      "[StreamSpecification](#cfn-dynamodb-globaltable-streamspecification)" : StreamSpecification,
      "[TableName](#cfn-dynamodb-globaltable-tablename)" : String,
      "[TimeToLiveSpecification](#cfn-dynamodb-globaltable-timetolivespecification)" : TimeToLiveSpecification,
      "[WarmThroughput](#cfn-dynamodb-globaltable-warmthroughput)" : WarmThroughput,
      "[WriteOnDemandThroughputSettings](#cfn-dynamodb-globaltable-writeondemandthroughputsettings)" : WriteOnDemandThroughputSettings,
      "[WriteProvisionedThroughputSettings](#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings)" : WriteProvisionedThroughputSettings
    }
}
```

### YAML
<a name="aws-resource-dynamodb-globaltable-syntax.yaml"></a>

```
Type: AWS::DynamoDB::GlobalTable
Properties:
  [AttributeDefinitions](#cfn-dynamodb-globaltable-attributedefinitions): 
    - AttributeDefinition
  [BillingMode](#cfn-dynamodb-globaltable-billingmode): String
  [GlobalSecondaryIndexes](#cfn-dynamodb-globaltable-globalsecondaryindexes): 
    - GlobalSecondaryIndex
  [GlobalTableSourceArn](#cfn-dynamodb-globaltable-globaltablesourcearn): String
  [GlobalTableWitnesses](#cfn-dynamodb-globaltable-globaltablewitnesses): 
    - GlobalTableWitness
  [KeySchema](#cfn-dynamodb-globaltable-keyschema): 
    - KeySchema
  [LocalSecondaryIndexes](#cfn-dynamodb-globaltable-localsecondaryindexes): 
    - LocalSecondaryIndex
  [MultiRegionConsistency](#cfn-dynamodb-globaltable-multiregionconsistency): String
  [ReadOnDemandThroughputSettings](#cfn-dynamodb-globaltable-readondemandthroughputsettings): 
    ReadOnDemandThroughputSettings
  [ReadProvisionedThroughputSettings](#cfn-dynamodb-globaltable-readprovisionedthroughputsettings): 
    GlobalReadProvisionedThroughputSettings
  [Replicas](#cfn-dynamodb-globaltable-replicas): 
    - ReplicaSpecification
  [SSESpecification](#cfn-dynamodb-globaltable-ssespecification): 
    SSESpecification
  [StreamSpecification](#cfn-dynamodb-globaltable-streamspecification): 
    StreamSpecification
  [TableName](#cfn-dynamodb-globaltable-tablename): String
  [TimeToLiveSpecification](#cfn-dynamodb-globaltable-timetolivespecification): 
    TimeToLiveSpecification
  [WarmThroughput](#cfn-dynamodb-globaltable-warmthroughput): 
    WarmThroughput
  [WriteOnDemandThroughputSettings](#cfn-dynamodb-globaltable-writeondemandthroughputsettings): 
    WriteOnDemandThroughputSettings
  [WriteProvisionedThroughputSettings](#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings): 
    WriteProvisionedThroughputSettings
```

## Properties
<a name="aws-resource-dynamodb-globaltable-properties"></a>

`AttributeDefinitions`  <a name="cfn-dynamodb-globaltable-attributedefinitions"></a>
A list of attributes that describe the key schema for the global table and indexes.  
*Required*: No  
*Type*: Array of [AttributeDefinition](aws-properties-dynamodb-globaltable-attributedefinition.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BillingMode`  <a name="cfn-dynamodb-globaltable-billingmode"></a>
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`.  
*Required*: No  
*Type*: String  
*Allowed values*: `PROVISIONED | PAY_PER_REQUEST`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GlobalSecondaryIndexes`  <a name="cfn-dynamodb-globaltable-globalsecondaryindexes"></a>
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.  
*Required*: No  
*Type*: Array of [GlobalSecondaryIndex](aws-properties-dynamodb-globaltable-globalsecondaryindex.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GlobalTableSourceArn`  <a name="cfn-dynamodb-globaltable-globaltablesourcearn"></a>
The ARN of the source table for multi-account global table replication.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`GlobalTableWitnesses`  <a name="cfn-dynamodb-globaltable-globaltablewitnesses"></a>
The list of witnesses of the MRSC global table. Only one witness Region can be configured per MRSC global table.  
*Required*: No  
*Type*: Array of [GlobalTableWitness](aws-properties-dynamodb-globaltable-globaltablewitness.md)  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KeySchema`  <a name="cfn-dynamodb-globaltable-keyschema"></a>
Specifies the attributes that make up the primary key for the table. The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property.  
*Required*: No  
*Type*: [Array](aws-properties-dynamodb-globaltable-keyschema.md) of [KeySchema](aws-properties-dynamodb-globaltable-keyschema.md)  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`LocalSecondaryIndexes`  <a name="cfn-dynamodb-globaltable-localsecondaryindexes"></a>
Local secondary indexes to be created on the table. You can create up to five local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. Each replica in your global table will have the same local secondary index settings.  
*Required*: No  
*Type*: Array of [LocalSecondaryIndex](aws-properties-dynamodb-globaltable-localsecondaryindex.md)  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`MultiRegionConsistency`  <a name="cfn-dynamodb-globaltable-multiregionconsistency"></a>
Specifies the consistency mode for a new global table.  
You can specify one of the following consistency modes:  
+ `EVENTUAL`: Configures a new global table for multi-Region eventual consistency (MREC).
+ `STRONG`: Configures a new global table for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to `EVENTUAL`. For more information about global tables consistency modes, see [ Consistency modes](https://docs.aws.amazon.com/V2globaltables_HowItWorks.html#V2globaltables_HowItWorks.consistency-modes) in DynamoDB developer guide.   
*Required*: No  
*Type*: String  
*Allowed values*: `EVENTUAL | STRONG`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReadOnDemandThroughputSettings`  <a name="cfn-dynamodb-globaltable-readondemandthroughputsettings"></a>
Sets the read request settings for the global table, which applies to all replicas. This can only be applied for multi-account global tables.  
*Required*: No  
*Type*: [ReadOnDemandThroughputSettings](aws-properties-dynamodb-globaltable-readondemandthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReadProvisionedThroughputSettings`  <a name="cfn-dynamodb-globaltable-readprovisionedthroughputsettings"></a>
Sets read capacity settings for the global table, which applies to all replicas. This can only be applied for multi-account global tables.  
*Required*: No  
*Type*: [GlobalReadProvisionedThroughputSettings](aws-properties-dynamodb-globaltable-globalreadprovisionedthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Replicas`  <a name="cfn-dynamodb-globaltable-replicas"></a>
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. For Multi-Region Strong Consistency (MRSC), you can add or remove up to 3 replicas, or 2 replicas plus a witness Region.  
*Required*: Yes  
*Type*: Array of [ReplicaSpecification](aws-properties-dynamodb-globaltable-replicaspecification.md)  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SSESpecification`  <a name="cfn-dynamodb-globaltable-ssespecification"></a>
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.  
*Required*: No  
*Type*: [SSESpecification](aws-properties-dynamodb-globaltable-ssespecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StreamSpecification`  <a name="cfn-dynamodb-globaltable-streamspecification"></a>
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. For Multi-Region Strong Consistency (MRSC), you do not need to provide a value for this property and can change the settings at any time.  
*Required*: No  
*Type*: [StreamSpecification](aws-properties-dynamodb-globaltable-streamspecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TableName`  <a name="cfn-dynamodb-globaltable-tablename"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).  
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.
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9_.-]+`  
*Minimum*: `3`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TimeToLiveSpecification`  <a name="cfn-dynamodb-globaltable-timetolivespecification"></a>
Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.  
*Required*: No  
*Type*: [TimeToLiveSpecification](aws-properties-dynamodb-globaltable-timetolivespecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WarmThroughput`  <a name="cfn-dynamodb-globaltable-warmthroughput"></a>
Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the `UpdateTable` operation to meet the throughput requirements of an upcoming peak event.  
*Required*: No  
*Type*: [WarmThroughput](aws-properties-dynamodb-globaltable-warmthroughput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WriteOnDemandThroughputSettings`  <a name="cfn-dynamodb-globaltable-writeondemandthroughputsettings"></a>
Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.  
*Required*: No  
*Type*: [WriteOnDemandThroughputSettings](aws-properties-dynamodb-globaltable-writeondemandthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WriteProvisionedThroughputSettings`  <a name="cfn-dynamodb-globaltable-writeprovisionedthroughputsettings"></a>
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`.  
*Required*: No  
*Type*: [WriteProvisionedThroughputSettings](aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-dynamodb-globaltable-return-values"></a>

### Ref
<a name="aws-resource-dynamodb-globaltable-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the table name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-dynamodb-globaltable-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-dynamodb-globaltable-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
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.

`StreamArn`  <a name="StreamArn-fn::getatt"></a>
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.

`TableId`  <a name="TableId-fn::getatt"></a>
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.

# AWS::DynamoDB::GlobalTable AttributeDefinition
<a name="aws-properties-dynamodb-globaltable-attributedefinition"></a>

Represents an attribute for describing the schema for the table and indexes.

## Syntax
<a name="aws-properties-dynamodb-globaltable-attributedefinition-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-attributedefinition-syntax.json"></a>

```
{
  "[AttributeName](#cfn-dynamodb-globaltable-attributedefinition-attributename)" : String,
  "[AttributeType](#cfn-dynamodb-globaltable-attributedefinition-attributetype)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-attributedefinition-syntax.yaml"></a>

```
  [AttributeName](#cfn-dynamodb-globaltable-attributedefinition-attributename): String
  [AttributeType](#cfn-dynamodb-globaltable-attributedefinition-attributetype): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-attributedefinition-properties"></a>

`AttributeName`  <a name="cfn-dynamodb-globaltable-attributedefinition-attributename"></a>
A name for the attribute.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AttributeType`  <a name="cfn-dynamodb-globaltable-attributedefinition-attributetype"></a>
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
*Required*: Yes  
*Type*: String  
*Allowed values*: `S | N | B`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable CapacityAutoScalingSettings
<a name="aws-properties-dynamodb-globaltable-capacityautoscalingsettings"></a>

Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.

## Syntax
<a name="aws-properties-dynamodb-globaltable-capacityautoscalingsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-capacityautoscalingsettings-syntax.json"></a>

```
{
  "[MaxCapacity](#cfn-dynamodb-globaltable-capacityautoscalingsettings-maxcapacity)" : Integer,
  "[MinCapacity](#cfn-dynamodb-globaltable-capacityautoscalingsettings-mincapacity)" : Integer,
  "[SeedCapacity](#cfn-dynamodb-globaltable-capacityautoscalingsettings-seedcapacity)" : Integer,
  "[TargetTrackingScalingPolicyConfiguration](#cfn-dynamodb-globaltable-capacityautoscalingsettings-targettrackingscalingpolicyconfiguration)" : TargetTrackingScalingPolicyConfiguration
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-capacityautoscalingsettings-syntax.yaml"></a>

```
  [MaxCapacity](#cfn-dynamodb-globaltable-capacityautoscalingsettings-maxcapacity): Integer
  [MinCapacity](#cfn-dynamodb-globaltable-capacityautoscalingsettings-mincapacity): Integer
  [SeedCapacity](#cfn-dynamodb-globaltable-capacityautoscalingsettings-seedcapacity): Integer
  [TargetTrackingScalingPolicyConfiguration](#cfn-dynamodb-globaltable-capacityautoscalingsettings-targettrackingscalingpolicyconfiguration): 
    TargetTrackingScalingPolicyConfiguration
```

## Properties
<a name="aws-properties-dynamodb-globaltable-capacityautoscalingsettings-properties"></a>

`MaxCapacity`  <a name="cfn-dynamodb-globaltable-capacityautoscalingsettings-maxcapacity"></a>
The maximum provisioned capacity units for the global table.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinCapacity`  <a name="cfn-dynamodb-globaltable-capacityautoscalingsettings-mincapacity"></a>
The minimum provisioned capacity units for the global table.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SeedCapacity`  <a name="cfn-dynamodb-globaltable-capacityautoscalingsettings-seedcapacity"></a>
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`.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetTrackingScalingPolicyConfiguration`  <a name="cfn-dynamodb-globaltable-capacityautoscalingsettings-targettrackingscalingpolicyconfiguration"></a>
Defines a target tracking scaling policy.  
*Required*: Yes  
*Type*: [TargetTrackingScalingPolicyConfiguration](aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable ContributorInsightsSpecification
<a name="aws-properties-dynamodb-globaltable-contributorinsightsspecification"></a>

Configures contributor insights settings for a replica or one of its indexes.

## Syntax
<a name="aws-properties-dynamodb-globaltable-contributorinsightsspecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-contributorinsightsspecification-syntax.json"></a>

```
{
  "[Enabled](#cfn-dynamodb-globaltable-contributorinsightsspecification-enabled)" : Boolean,
  "[Mode](#cfn-dynamodb-globaltable-contributorinsightsspecification-mode)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-contributorinsightsspecification-syntax.yaml"></a>

```
  [Enabled](#cfn-dynamodb-globaltable-contributorinsightsspecification-enabled): Boolean
  [Mode](#cfn-dynamodb-globaltable-contributorinsightsspecification-mode): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-contributorinsightsspecification-properties"></a>

`Enabled`  <a name="cfn-dynamodb-globaltable-contributorinsightsspecification-enabled"></a>
Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Mode`  <a name="cfn-dynamodb-globaltable-contributorinsightsspecification-mode"></a>
Specifies the CloudWatch Contributor Insights mode for a global table. Valid values are `ACCESSED_AND_THROTTLED_KEYS` (tracks all access and throttled events) or `THROTTLED_KEYS` (tracks only throttled events). This setting determines what type of contributor insights data is collected for the global table.  
*Required*: No  
*Type*: String  
*Allowed values*: `ACCESSED_AND_THROTTLED_KEYS | THROTTLED_KEYS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable GlobalReadProvisionedThroughputSettings
<a name="aws-properties-dynamodb-globaltable-globalreadprovisionedthroughputsettings"></a>

Sets read capacity settings for the multi-account global table or its global secondary index.

## Syntax
<a name="aws-properties-dynamodb-globaltable-globalreadprovisionedthroughputsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-globalreadprovisionedthroughputsettings-syntax.json"></a>

```
{
  "[ReadCapacityUnits](#cfn-dynamodb-globaltable-globalreadprovisionedthroughputsettings-readcapacityunits)" : Integer
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-globalreadprovisionedthroughputsettings-syntax.yaml"></a>

```
  [ReadCapacityUnits](#cfn-dynamodb-globaltable-globalreadprovisionedthroughputsettings-readcapacityunits): Integer
```

## Properties
<a name="aws-properties-dynamodb-globaltable-globalreadprovisionedthroughputsettings-properties"></a>

`ReadCapacityUnits`  <a name="cfn-dynamodb-globaltable-globalreadprovisionedthroughputsettings-readcapacityunits"></a>
Sets read capacity settings for the multi-account global table or its global secondary index.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable GlobalSecondaryIndex
<a name="aws-properties-dynamodb-globaltable-globalsecondaryindex"></a>

Allows you to specify a global secondary index for the global table. The index will be defined on all replicas.

## Syntax
<a name="aws-properties-dynamodb-globaltable-globalsecondaryindex-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-globalsecondaryindex-syntax.json"></a>

```
{
  "[IndexName](#cfn-dynamodb-globaltable-globalsecondaryindex-indexname)" : String,
  "[KeySchema](#cfn-dynamodb-globaltable-globalsecondaryindex-keyschema)" : [ KeySchema, ... ],
  "[Projection](#cfn-dynamodb-globaltable-globalsecondaryindex-projection)" : Projection,
  "[ReadOnDemandThroughputSettings](#cfn-dynamodb-globaltable-globalsecondaryindex-readondemandthroughputsettings)" : ReadOnDemandThroughputSettings,
  "[ReadProvisionedThroughputSettings](#cfn-dynamodb-globaltable-globalsecondaryindex-readprovisionedthroughputsettings)" : GlobalReadProvisionedThroughputSettings,
  "[WarmThroughput](#cfn-dynamodb-globaltable-globalsecondaryindex-warmthroughput)" : WarmThroughput,
  "[WriteOnDemandThroughputSettings](#cfn-dynamodb-globaltable-globalsecondaryindex-writeondemandthroughputsettings)" : WriteOnDemandThroughputSettings,
  "[WriteProvisionedThroughputSettings](#cfn-dynamodb-globaltable-globalsecondaryindex-writeprovisionedthroughputsettings)" : WriteProvisionedThroughputSettings
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-globalsecondaryindex-syntax.yaml"></a>

```
  [IndexName](#cfn-dynamodb-globaltable-globalsecondaryindex-indexname): String
  [KeySchema](#cfn-dynamodb-globaltable-globalsecondaryindex-keyschema): 
    - KeySchema
  [Projection](#cfn-dynamodb-globaltable-globalsecondaryindex-projection): 
    Projection
  [ReadOnDemandThroughputSettings](#cfn-dynamodb-globaltable-globalsecondaryindex-readondemandthroughputsettings): 
    ReadOnDemandThroughputSettings
  [ReadProvisionedThroughputSettings](#cfn-dynamodb-globaltable-globalsecondaryindex-readprovisionedthroughputsettings): 
    GlobalReadProvisionedThroughputSettings
  [WarmThroughput](#cfn-dynamodb-globaltable-globalsecondaryindex-warmthroughput): 
    WarmThroughput
  [WriteOnDemandThroughputSettings](#cfn-dynamodb-globaltable-globalsecondaryindex-writeondemandthroughputsettings): 
    WriteOnDemandThroughputSettings
  [WriteProvisionedThroughputSettings](#cfn-dynamodb-globaltable-globalsecondaryindex-writeprovisionedthroughputsettings): 
    WriteProvisionedThroughputSettings
```

## Properties
<a name="aws-properties-dynamodb-globaltable-globalsecondaryindex-properties"></a>

`IndexName`  <a name="cfn-dynamodb-globaltable-globalsecondaryindex-indexname"></a>
The name of the global secondary index. The name must be unique among all other indexes on this table.  
*Required*: Yes  
*Type*: String  
*Minimum*: `3`  
*Maximum*: `255`  
*Update requires*: Updates are not supported.

`KeySchema`  <a name="cfn-dynamodb-globaltable-globalsecondaryindex-keyschema"></a>
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.
*Required*: Yes  
*Type*: [Array](aws-properties-dynamodb-globaltable-keyschema.md) of [KeySchema](aws-properties-dynamodb-globaltable-keyschema.md)  
*Minimum*: `1`  
*Maximum*: `8`  
*Update requires*: Updates are not supported.

`Projection`  <a name="cfn-dynamodb-globaltable-globalsecondaryindex-projection"></a>
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.  
*Required*: Yes  
*Type*: [Projection](aws-properties-dynamodb-globaltable-projection.md)  
*Update requires*: Updates are not supported.

`ReadOnDemandThroughputSettings`  <a name="cfn-dynamodb-globaltable-globalsecondaryindex-readondemandthroughputsettings"></a>
Sets read capacity settings for the global secondary index of the global table, which applies to all replicas. This can only be applied for multi-account global tables.  
*Required*: No  
*Type*: [ReadOnDemandThroughputSettings](aws-properties-dynamodb-globaltable-readondemandthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReadProvisionedThroughputSettings`  <a name="cfn-dynamodb-globaltable-globalsecondaryindex-readprovisionedthroughputsettings"></a>
Sets the read request settings for the global secondary index of the global table, which applies to all replicas. This can only be applied for multi-account global tables.  
*Required*: No  
*Type*: [GlobalReadProvisionedThroughputSettings](aws-properties-dynamodb-globaltable-globalreadprovisionedthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WarmThroughput`  <a name="cfn-dynamodb-globaltable-globalsecondaryindex-warmthroughput"></a>
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify `ReadUnitsPerSecond`, `WriteUnitsPerSecond`, or both.  
*Required*: No  
*Type*: [WarmThroughput](aws-properties-dynamodb-globaltable-warmthroughput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WriteOnDemandThroughputSettings`  <a name="cfn-dynamodb-globaltable-globalsecondaryindex-writeondemandthroughputsettings"></a>
Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.  
*Required*: No  
*Type*: [WriteOnDemandThroughputSettings](aws-properties-dynamodb-globaltable-writeondemandthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WriteProvisionedThroughputSettings`  <a name="cfn-dynamodb-globaltable-globalsecondaryindex-writeprovisionedthroughputsettings"></a>
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.  
*Required*: No  
*Type*: [WriteProvisionedThroughputSettings](aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable GlobalTableWitness
<a name="aws-properties-dynamodb-globaltable-globaltablewitness"></a>

The witness Region for the MRSC global table. A MRSC global table can be configured with either three replicas, or with two replicas and one witness.

The witness must be in a different Region than the replicas and within the same Region set:
+ US Region set: US East (N. Virginia), US East (Ohio), US West (Oregon)
+ EU Region set: Europe (Ireland), Europe (London), Europe (Paris), Europe (Frankfurt)
+ AP Region set: Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Osaka)

## Syntax
<a name="aws-properties-dynamodb-globaltable-globaltablewitness-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-globaltablewitness-syntax.json"></a>

```
{
  "[Region](#cfn-dynamodb-globaltable-globaltablewitness-region)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-globaltablewitness-syntax.yaml"></a>

```
  [Region](#cfn-dynamodb-globaltable-globaltablewitness-region): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-globaltablewitness-properties"></a>

`Region`  <a name="cfn-dynamodb-globaltable-globaltablewitness-region"></a>
The name of the AWSRegion that serves as a witness for the MRSC global table.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable KeySchema
<a name="aws-properties-dynamodb-globaltable-keyschema"></a>

Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A `KeySchemaElement` represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one `KeySchemaElement` (for the partition key). A composite primary key would require one `KeySchemaElement` for the partition key, and another `KeySchemaElement` for the sort key.

A `KeySchemaElement` must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

## Syntax
<a name="aws-properties-dynamodb-globaltable-keyschema-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-keyschema-syntax.json"></a>

```
{
  "[AttributeName](#cfn-dynamodb-globaltable-keyschema-attributename)" : String,
  "[KeyType](#cfn-dynamodb-globaltable-keyschema-keytype)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-keyschema-syntax.yaml"></a>

```
  [AttributeName](#cfn-dynamodb-globaltable-keyschema-attributename): String
  [KeyType](#cfn-dynamodb-globaltable-keyschema-keytype): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-keyschema-properties"></a>

`AttributeName`  <a name="cfn-dynamodb-globaltable-keyschema-attributename"></a>
The name of a key attribute.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`KeyType`  <a name="cfn-dynamodb-globaltable-keyschema-keytype"></a>
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.
*Required*: Yes  
*Type*: String  
*Allowed values*: `HASH | RANGE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::DynamoDB::GlobalTable KinesisStreamSpecification
<a name="aws-properties-dynamodb-globaltable-kinesisstreamspecification"></a>

The Kinesis Data Streams configuration for the specified global table replica.

## Syntax
<a name="aws-properties-dynamodb-globaltable-kinesisstreamspecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-kinesisstreamspecification-syntax.json"></a>

```
{
  "[ApproximateCreationDateTimePrecision](#cfn-dynamodb-globaltable-kinesisstreamspecification-approximatecreationdatetimeprecision)" : String,
  "[StreamArn](#cfn-dynamodb-globaltable-kinesisstreamspecification-streamarn)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-kinesisstreamspecification-syntax.yaml"></a>

```
  [ApproximateCreationDateTimePrecision](#cfn-dynamodb-globaltable-kinesisstreamspecification-approximatecreationdatetimeprecision): String
  [StreamArn](#cfn-dynamodb-globaltable-kinesisstreamspecification-streamarn): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-kinesisstreamspecification-properties"></a>

`ApproximateCreationDateTimePrecision`  <a name="cfn-dynamodb-globaltable-kinesisstreamspecification-approximatecreationdatetimeprecision"></a>
The precision for the time and date that the stream was created.  
*Required*: No  
*Type*: String  
*Allowed values*: `MICROSECOND | MILLISECOND`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StreamArn`  <a name="cfn-dynamodb-globaltable-kinesisstreamspecification-streamarn"></a>
The ARN for a specific Kinesis data stream.  
*Required*: Yes  
*Type*: String  
*Minimum*: `37`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable LocalSecondaryIndex
<a name="aws-properties-dynamodb-globaltable-localsecondaryindex"></a>

Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created.

## Syntax
<a name="aws-properties-dynamodb-globaltable-localsecondaryindex-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-localsecondaryindex-syntax.json"></a>

```
{
  "[IndexName](#cfn-dynamodb-globaltable-localsecondaryindex-indexname)" : String,
  "[KeySchema](#cfn-dynamodb-globaltable-localsecondaryindex-keyschema)" : [ KeySchema, ... ],
  "[Projection](#cfn-dynamodb-globaltable-localsecondaryindex-projection)" : Projection
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-localsecondaryindex-syntax.yaml"></a>

```
  [IndexName](#cfn-dynamodb-globaltable-localsecondaryindex-indexname): String
  [KeySchema](#cfn-dynamodb-globaltable-localsecondaryindex-keyschema): 
    - KeySchema
  [Projection](#cfn-dynamodb-globaltable-localsecondaryindex-projection): 
    Projection
```

## Properties
<a name="aws-properties-dynamodb-globaltable-localsecondaryindex-properties"></a>

`IndexName`  <a name="cfn-dynamodb-globaltable-localsecondaryindex-indexname"></a>
The name of the local secondary index. The name must be unique among all other indexes on this table.  
*Required*: Yes  
*Type*: String  
*Minimum*: `3`  
*Maximum*: `255`  
*Update requires*: Updates are not supported.

`KeySchema`  <a name="cfn-dynamodb-globaltable-localsecondaryindex-keyschema"></a>
The complete key schema for the local secondary index, consisting 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.
*Required*: Yes  
*Type*: [Array](aws-properties-dynamodb-globaltable-keyschema.md) of [KeySchema](aws-properties-dynamodb-globaltable-keyschema.md)  
*Maximum*: `2`  
*Update requires*: Updates are not supported.

`Projection`  <a name="cfn-dynamodb-globaltable-localsecondaryindex-projection"></a>
Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.   
*Required*: Yes  
*Type*: [Projection](aws-properties-dynamodb-globaltable-projection.md)  
*Update requires*: Updates are not supported.

# AWS::DynamoDB::GlobalTable PointInTimeRecoverySpecification
<a name="aws-properties-dynamodb-globaltable-pointintimerecoveryspecification"></a>

Represents the settings used to enable point in time recovery.

## Syntax
<a name="aws-properties-dynamodb-globaltable-pointintimerecoveryspecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-pointintimerecoveryspecification-syntax.json"></a>

```
{
  "[PointInTimeRecoveryEnabled](#cfn-dynamodb-globaltable-pointintimerecoveryspecification-pointintimerecoveryenabled)" : Boolean,
  "[RecoveryPeriodInDays](#cfn-dynamodb-globaltable-pointintimerecoveryspecification-recoveryperiodindays)" : Integer
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-pointintimerecoveryspecification-syntax.yaml"></a>

```
  [PointInTimeRecoveryEnabled](#cfn-dynamodb-globaltable-pointintimerecoveryspecification-pointintimerecoveryenabled): Boolean
  [RecoveryPeriodInDays](#cfn-dynamodb-globaltable-pointintimerecoveryspecification-recoveryperiodindays): Integer
```

## Properties
<a name="aws-properties-dynamodb-globaltable-pointintimerecoveryspecification-properties"></a>

`PointInTimeRecoveryEnabled`  <a name="cfn-dynamodb-globaltable-pointintimerecoveryspecification-pointintimerecoveryenabled"></a>
Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RecoveryPeriodInDays`  <a name="cfn-dynamodb-globaltable-pointintimerecoveryspecification-recoveryperiodindays"></a>
The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional. If no value is provided, the value will default to 35.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `35`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable Projection
<a name="aws-properties-dynamodb-globaltable-projection"></a>

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

## Syntax
<a name="aws-properties-dynamodb-globaltable-projection-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-projection-syntax.json"></a>

```
{
  "[NonKeyAttributes](#cfn-dynamodb-globaltable-projection-nonkeyattributes)" : [ String, ... ],
  "[ProjectionType](#cfn-dynamodb-globaltable-projection-projectiontype)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-projection-syntax.yaml"></a>

```
  [NonKeyAttributes](#cfn-dynamodb-globaltable-projection-nonkeyattributes): 
    - String
  [ProjectionType](#cfn-dynamodb-globaltable-projection-projectiontype): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-projection-properties"></a>

`NonKeyAttributes`  <a name="cfn-dynamodb-globaltable-projection-nonkeyattributes"></a>
Represents the non-key attribute names which will be projected into the index.  
For global and local secondary indexes, the total count of `NonKeyAttributes` summed across all of the 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. This limit only applies when you specify the ProjectionType of `INCLUDE`. You still can specify the ProjectionType of `ALL` to project all attributes from the source table, even if the table has more than 100 attributes.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `20`  
*Update requires*: Updates are not supported.

`ProjectionType`  <a name="cfn-dynamodb-globaltable-projection-projectiontype"></a>
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.  
*Required*: No  
*Type*: String  
*Allowed values*: `ALL | KEYS_ONLY | INCLUDE`  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

# AWS::DynamoDB::GlobalTable ReadOnDemandThroughputSettings
<a name="aws-properties-dynamodb-globaltable-readondemandthroughputsettings"></a>

Sets the read request settings for a replica table or a replica global secondary index. You can only specify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.

## Syntax
<a name="aws-properties-dynamodb-globaltable-readondemandthroughputsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-readondemandthroughputsettings-syntax.json"></a>

```
{
  "[MaxReadRequestUnits](#cfn-dynamodb-globaltable-readondemandthroughputsettings-maxreadrequestunits)" : Integer
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-readondemandthroughputsettings-syntax.yaml"></a>

```
  [MaxReadRequestUnits](#cfn-dynamodb-globaltable-readondemandthroughputsettings-maxreadrequestunits): Integer
```

## Properties
<a name="aws-properties-dynamodb-globaltable-readondemandthroughputsettings-properties"></a>

`MaxReadRequestUnits`  <a name="cfn-dynamodb-globaltable-readondemandthroughputsettings-maxreadrequestunits"></a>
Maximum number of read request units for the specified replica of a global table.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable ReadProvisionedThroughputSettings
<a name="aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings"></a>

Allows you to specify the read capacity settings for a replica table or a replica global secondary index when the `BillingMode` is set to `PROVISIONED`. You must specify a value for either `ReadCapacityUnits` or `ReadCapacityAutoScalingSettings`, but not both. You can switch between fixed capacity and auto scaling.

## Syntax
<a name="aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings-syntax.json"></a>

```
{
  "[ReadCapacityAutoScalingSettings](#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityautoscalingsettings)" : CapacityAutoScalingSettings,
  "[ReadCapacityUnits](#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityunits)" : Integer
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings-syntax.yaml"></a>

```
  [ReadCapacityAutoScalingSettings](#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityautoscalingsettings): 
    CapacityAutoScalingSettings
  [ReadCapacityUnits](#cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityunits): Integer
```

## Properties
<a name="aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings-properties"></a>

`ReadCapacityAutoScalingSettings`  <a name="cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityautoscalingsettings"></a>
Specifies auto scaling settings for the replica table or global secondary index.  
*Required*: No  
*Type*: [CapacityAutoScalingSettings](aws-properties-dynamodb-globaltable-capacityautoscalingsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReadCapacityUnits`  <a name="cfn-dynamodb-globaltable-readprovisionedthroughputsettings-readcapacityunits"></a>
Specifies a fixed read capacity for the replica table or global secondary index.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable ReplicaGlobalSecondaryIndexSpecification
<a name="aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification"></a>

Represents the properties of a global secondary index that can be set on a per-replica basis.

## Syntax
<a name="aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification-syntax.json"></a>

```
{
  "[ContributorInsightsSpecification](#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-contributorinsightsspecification)" : ContributorInsightsSpecification,
  "[IndexName](#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-indexname)" : String,
  "[ReadOnDemandThroughputSettings](#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readondemandthroughputsettings)" : ReadOnDemandThroughputSettings,
  "[ReadProvisionedThroughputSettings](#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readprovisionedthroughputsettings)" : ReadProvisionedThroughputSettings
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification-syntax.yaml"></a>

```
  [ContributorInsightsSpecification](#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-contributorinsightsspecification): 
    ContributorInsightsSpecification
  [IndexName](#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-indexname): String
  [ReadOnDemandThroughputSettings](#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readondemandthroughputsettings): 
    ReadOnDemandThroughputSettings
  [ReadProvisionedThroughputSettings](#cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readprovisionedthroughputsettings): 
    ReadProvisionedThroughputSettings
```

## Properties
<a name="aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification-properties"></a>

`ContributorInsightsSpecification`  <a name="cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-contributorinsightsspecification"></a>
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.  
*Required*: No  
*Type*: [ContributorInsightsSpecification](aws-properties-dynamodb-globaltable-contributorinsightsspecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IndexName`  <a name="cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-indexname"></a>
The name of the global secondary index. The name must be unique among all other indexes on this table.  
*Required*: Yes  
*Type*: String  
*Minimum*: `3`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ReadOnDemandThroughputSettings`  <a name="cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readondemandthroughputsettings"></a>
Sets the read request settings for a replica global secondary index. You can only specify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.  
*Required*: No  
*Type*: [ReadOnDemandThroughputSettings](aws-properties-dynamodb-globaltable-readondemandthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReadProvisionedThroughputSettings`  <a name="cfn-dynamodb-globaltable-replicaglobalsecondaryindexspecification-readprovisionedthroughputsettings"></a>
Allows you to specify the read capacity settings for a replica global secondary index when the `BillingMode` is set to `PROVISIONED`.  
*Required*: No  
*Type*: [ReadProvisionedThroughputSettings](aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable ReplicaSpecification
<a name="aws-properties-dynamodb-globaltable-replicaspecification"></a>

Defines settings specific to a single replica of a global table.

## Syntax
<a name="aws-properties-dynamodb-globaltable-replicaspecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-replicaspecification-syntax.json"></a>

```
{
  "[ContributorInsightsSpecification](#cfn-dynamodb-globaltable-replicaspecification-contributorinsightsspecification)" : ContributorInsightsSpecification,
  "[DeletionProtectionEnabled](#cfn-dynamodb-globaltable-replicaspecification-deletionprotectionenabled)" : Boolean,
  "[GlobalSecondaryIndexes](#cfn-dynamodb-globaltable-replicaspecification-globalsecondaryindexes)" : [ ReplicaGlobalSecondaryIndexSpecification, ... ],
  "[GlobalTableSettingsReplicationMode](#cfn-dynamodb-globaltable-replicaspecification-globaltablesettingsreplicationmode)" : String,
  "[KinesisStreamSpecification](#cfn-dynamodb-globaltable-replicaspecification-kinesisstreamspecification)" : KinesisStreamSpecification,
  "[PointInTimeRecoverySpecification](#cfn-dynamodb-globaltable-replicaspecification-pointintimerecoveryspecification)" : PointInTimeRecoverySpecification,
  "[ReadOnDemandThroughputSettings](#cfn-dynamodb-globaltable-replicaspecification-readondemandthroughputsettings)" : ReadOnDemandThroughputSettings,
  "[ReadProvisionedThroughputSettings](#cfn-dynamodb-globaltable-replicaspecification-readprovisionedthroughputsettings)" : ReadProvisionedThroughputSettings,
  "[Region](#cfn-dynamodb-globaltable-replicaspecification-region)" : String,
  "[ReplicaStreamSpecification](#cfn-dynamodb-globaltable-replicaspecification-replicastreamspecification)" : ReplicaStreamSpecification,
  "[ResourcePolicy](#cfn-dynamodb-globaltable-replicaspecification-resourcepolicy)" : ResourcePolicy,
  "[SSESpecification](#cfn-dynamodb-globaltable-replicaspecification-ssespecification)" : ReplicaSSESpecification,
  "[TableClass](#cfn-dynamodb-globaltable-replicaspecification-tableclass)" : String,
  "[Tags](#cfn-dynamodb-globaltable-replicaspecification-tags)" : [ Tag, ... ]
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-replicaspecification-syntax.yaml"></a>

```
  [ContributorInsightsSpecification](#cfn-dynamodb-globaltable-replicaspecification-contributorinsightsspecification): 
    ContributorInsightsSpecification
  [DeletionProtectionEnabled](#cfn-dynamodb-globaltable-replicaspecification-deletionprotectionenabled): Boolean
  [GlobalSecondaryIndexes](#cfn-dynamodb-globaltable-replicaspecification-globalsecondaryindexes): 
    - ReplicaGlobalSecondaryIndexSpecification
  [GlobalTableSettingsReplicationMode](#cfn-dynamodb-globaltable-replicaspecification-globaltablesettingsreplicationmode): String
  [KinesisStreamSpecification](#cfn-dynamodb-globaltable-replicaspecification-kinesisstreamspecification): 
    KinesisStreamSpecification
  [PointInTimeRecoverySpecification](#cfn-dynamodb-globaltable-replicaspecification-pointintimerecoveryspecification): 
    PointInTimeRecoverySpecification
  [ReadOnDemandThroughputSettings](#cfn-dynamodb-globaltable-replicaspecification-readondemandthroughputsettings): 
    ReadOnDemandThroughputSettings
  [ReadProvisionedThroughputSettings](#cfn-dynamodb-globaltable-replicaspecification-readprovisionedthroughputsettings): 
    ReadProvisionedThroughputSettings
  [Region](#cfn-dynamodb-globaltable-replicaspecification-region): String
  [ReplicaStreamSpecification](#cfn-dynamodb-globaltable-replicaspecification-replicastreamspecification): 
    ReplicaStreamSpecification
  [ResourcePolicy](#cfn-dynamodb-globaltable-replicaspecification-resourcepolicy): 
    ResourcePolicy
  [SSESpecification](#cfn-dynamodb-globaltable-replicaspecification-ssespecification): 
    ReplicaSSESpecification
  [TableClass](#cfn-dynamodb-globaltable-replicaspecification-tableclass): String
  [Tags](#cfn-dynamodb-globaltable-replicaspecification-tags): 
    - Tag
```

## Properties
<a name="aws-properties-dynamodb-globaltable-replicaspecification-properties"></a>

`ContributorInsightsSpecification`  <a name="cfn-dynamodb-globaltable-replicaspecification-contributorinsightsspecification"></a>
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.  
*Required*: No  
*Type*: [ContributorInsightsSpecification](aws-properties-dynamodb-globaltable-contributorinsightsspecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeletionProtectionEnabled`  <a name="cfn-dynamodb-globaltable-replicaspecification-deletionprotectionenabled"></a>
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Amazon DynamoDBDeveloper Guide*.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GlobalSecondaryIndexes`  <a name="cfn-dynamodb-globaltable-replicaspecification-globalsecondaryindexes"></a>
Defines additional settings for the global secondary indexes of this replica.  
*Required*: No  
*Type*: Array of [ReplicaGlobalSecondaryIndexSpecification](aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GlobalTableSettingsReplicationMode`  <a name="cfn-dynamodb-globaltable-replicaspecification-globaltablesettingsreplicationmode"></a>
The replication mode for global table settings across multiple accounts. In a multi-account global table, you cannot make changes to a synchronized setting using CloudFormation. You need to use console or CLI to make any settings changes.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KinesisStreamSpecification`  <a name="cfn-dynamodb-globaltable-replicaspecification-kinesisstreamspecification"></a>
Defines the Kinesis Data Streams configuration for the specified replica.  
*Required*: No  
*Type*: [KinesisStreamSpecification](aws-properties-dynamodb-globaltable-kinesisstreamspecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PointInTimeRecoverySpecification`  <a name="cfn-dynamodb-globaltable-replicaspecification-pointintimerecoveryspecification"></a>
The settings used to enable point in time recovery. When not specified, defaults to point in time recovery disabled for the replica.  
*Required*: No  
*Type*: [PointInTimeRecoverySpecification](aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReadOnDemandThroughputSettings`  <a name="cfn-dynamodb-globaltable-replicaspecification-readondemandthroughputsettings"></a>
Sets read request settings for the replica table.  
*Required*: No  
*Type*: [ReadOnDemandThroughputSettings](aws-properties-dynamodb-globaltable-readondemandthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReadProvisionedThroughputSettings`  <a name="cfn-dynamodb-globaltable-replicaspecification-readprovisionedthroughputsettings"></a>
Defines read capacity settings for the replica table.  
*Required*: No  
*Type*: [ReadProvisionedThroughputSettings](aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Region`  <a name="cfn-dynamodb-globaltable-replicaspecification-region"></a>
The region in which this replica exists.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReplicaStreamSpecification`  <a name="cfn-dynamodb-globaltable-replicaspecification-replicastreamspecification"></a>
Represents the DynamoDB Streams configuration for a global table replica.   
*Required*: No  
*Type*: [ReplicaStreamSpecification](aws-properties-dynamodb-globaltable-replicastreamspecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourcePolicy`  <a name="cfn-dynamodb-globaltable-replicaspecification-resourcepolicy"></a>
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).  
*Required*: No  
*Type*: [ResourcePolicy](aws-properties-dynamodb-globaltable-resourcepolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SSESpecification`  <a name="cfn-dynamodb-globaltable-replicaspecification-ssespecification"></a>
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.  
*Required*: No  
*Type*: [ReplicaSSESpecification](aws-properties-dynamodb-globaltable-replicassespecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TableClass`  <a name="cfn-dynamodb-globaltable-replicaspecification-tableclass"></a>
The table class of the specified table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`.  
*Required*: No  
*Type*: String  
*Allowed values*: `STANDARD | STANDARD_INFREQUENT_ACCESS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-dynamodb-globaltable-replicaspecification-tags"></a>
An array of key-value pairs to apply to this replica.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-dynamodb-globaltable-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable ReplicaSSESpecification
<a name="aws-properties-dynamodb-globaltable-replicassespecification"></a>

Allows you to specify a KMS key identifier to be used for server-side encryption. The key can be specified via ARN, key ID, or alias. The key must be created in the same region as the replica.

## Syntax
<a name="aws-properties-dynamodb-globaltable-replicassespecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-replicassespecification-syntax.json"></a>

```
{
  "[KMSMasterKeyId](#cfn-dynamodb-globaltable-replicassespecification-kmsmasterkeyid)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-replicassespecification-syntax.yaml"></a>

```
  [KMSMasterKeyId](#cfn-dynamodb-globaltable-replicassespecification-kmsmasterkeyid): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-replicassespecification-properties"></a>

`KMSMasterKeyId`  <a name="cfn-dynamodb-globaltable-replicassespecification-kmsmasterkeyid"></a>
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`.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable ReplicaStreamSpecification
<a name="aws-properties-dynamodb-globaltable-replicastreamspecification"></a>

Represents the DynamoDB Streams configuration for a global table replica.

## Syntax
<a name="aws-properties-dynamodb-globaltable-replicastreamspecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-replicastreamspecification-syntax.json"></a>

```
{
  "[ResourcePolicy](#cfn-dynamodb-globaltable-replicastreamspecification-resourcepolicy)" : ResourcePolicy
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-replicastreamspecification-syntax.yaml"></a>

```
  [ResourcePolicy](#cfn-dynamodb-globaltable-replicastreamspecification-resourcepolicy): 
    ResourcePolicy
```

## Properties
<a name="aws-properties-dynamodb-globaltable-replicastreamspecification-properties"></a>

`ResourcePolicy`  <a name="cfn-dynamodb-globaltable-replicastreamspecification-resourcepolicy"></a>
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.  
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).  
You can update the `ResourcePolicy` property if you've specified more than one table using the [AWS::DynamoDB::GlobalTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html) resource.  
*Required*: Yes  
*Type*: [ResourcePolicy](aws-properties-dynamodb-globaltable-resourcepolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable ResourcePolicy
<a name="aws-properties-dynamodb-globaltable-resourcepolicy"></a>

Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table, its indexes, and stream. 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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).

While defining resource-based policies in your CloudFormation templates, the following considerations apply:
+ The maximum size supported for a resource-based policy document in JSON format is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. 
+ Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CloudFormation stack template, you'll need to update the CloudFormation stack with the changes.
+ Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CloudFormation template, the change won't be overwritten if there are no changes to the policy within the template.

  For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DynamoDB won’t be synced with the policy in the template.

  Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DynamoDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DynamoDB will be updated to match the one defined in the template.
+ Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.
+ The [AWS::DynamoDB::GlobalTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html) resource doesn't support creating a replica in the same stack update in Regions other than the Region where you deploy the stack update.

For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).

## Syntax
<a name="aws-properties-dynamodb-globaltable-resourcepolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-resourcepolicy-syntax.json"></a>

```
{
  "[PolicyDocument](#cfn-dynamodb-globaltable-resourcepolicy-policydocument)" : Json
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-resourcepolicy-syntax.yaml"></a>

```
  [PolicyDocument](#cfn-dynamodb-globaltable-resourcepolicy-policydocument): Json
```

## Properties
<a name="aws-properties-dynamodb-globaltable-resourcepolicy-properties"></a>

`PolicyDocument`  <a name="cfn-dynamodb-globaltable-resourcepolicy-policydocument"></a>
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).  
*Required*: Yes  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Examples
<a name="aws-properties-dynamodb-globaltable-resourcepolicy--examples"></a>

### Attaching a resource-based policy to a DynamoDB table created using the `AWS::DynamoDB::GlobalTable` resource.
<a name="aws-properties-dynamodb-globaltable-resourcepolicy--examples--Attaching_a_resource-based_policy_to_a_table_created_using_the_::DynamoDB::GlobalTable_resource."></a>

The following CloudFormation template creates a table with the [AWS::DynamoDB::GlobalTable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html) resource and attaches a resource-based policy to the table and its stream. This policy allows the user `foobar` to perform the [GetItem](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html) operation on the table. Additionally, the following template enables a stream and then attaches a resource-based policy to the stream. The resource-based policy for the stream allows the user `foobar` to perform the [GetRecords](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetRecords.html), [GetShardIterator](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetShardIterator.html), and [DescribeStream](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_DescribeStream.html) operations on the stream.

**Important**  
If you enable a stream within a CloudFormation template and also define a policy for the stream, the policy is attached to the stream only after the stream is enabled, but before the stack update is complete.

#### JSON
<a name="aws-properties-dynamodb-globaltable-resourcepolicy--examples--Attaching_a_resource-based_policy_to_a_table_created_using_the_::DynamoDB::GlobalTable_resource.--json"></a>

```
{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": {
            "GlobalMusicCollection": { "Type": "AWS::DynamoDB::GlobalTable", "Properties": {
            "TableName": "MusicCollection", "AttributeDefinitions": [{ "AttributeName": "Artist",
            "AttributeType": "S" }], "KeySchema": [{ "AttributeName": "Artist", "KeyType": "HASH"
            }], "BillingMode": "PAY_PER_REQUEST", "StreamSpecification": { "StreamViewType":
            "NEW_AND_OLD_IMAGES" }, "Replicas": [ { "Region": "us-east-1", "ResourcePolicy": {
            "PolicyDocument": { "Version": "2012-10-17",		 	 	  "Statement": [{ "Principal": { "AWS": [
            "arn:aws:iam::111122223333:user/foobar" ] }, "Effect": "Allow", "Action":
            "dynamodb:GetItem", "Resource": "*" }] } }, "ReplicaStreamSpecification": {
            "ResourcePolicy": { "PolicyDocument": { "Version": "2012-10-17",		 	 	  "Statement": [{
            "Principal": { "AWS": "arn:aws:iam::111122223333:user/foobar" }, "Effect": "Allow",
            "Action": [ "dynamodb:GetRecords", "dynamodb:GetShardIterator",
            "dynamodb:DescribeStream" ], "Resource": "*" }] } } } } ] } } } }
```

# AWS::DynamoDB::GlobalTable SSESpecification
<a name="aws-properties-dynamodb-globaltable-ssespecification"></a>

Represents the settings used to enable server-side encryption.

## Syntax
<a name="aws-properties-dynamodb-globaltable-ssespecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-ssespecification-syntax.json"></a>

```
{
  "[SSEEnabled](#cfn-dynamodb-globaltable-ssespecification-sseenabled)" : Boolean,
  "[SSEType](#cfn-dynamodb-globaltable-ssespecification-ssetype)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-ssespecification-syntax.yaml"></a>

```
  [SSEEnabled](#cfn-dynamodb-globaltable-ssespecification-sseenabled): Boolean
  [SSEType](#cfn-dynamodb-globaltable-ssespecification-ssetype): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-ssespecification-properties"></a>

`SSEEnabled`  <a name="cfn-dynamodb-globaltable-ssespecification-sseenabled"></a>
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.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SSEType`  <a name="cfn-dynamodb-globaltable-ssespecification-ssetype"></a>
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).
*Required*: No  
*Type*: String  
*Allowed values*: `AES256 | KMS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable StreamSpecification
<a name="aws-properties-dynamodb-globaltable-streamspecification"></a>

Represents the DynamoDB Streams configuration for a table in DynamoDB.

You can only modify this value for a `AWS::DynamoDB::GlobalTable` resource configured for multi-Region eventual consistency (MREC, the default) if that resource contains only one entry in `Replicas`. You must specify a value for this property for a `AWS::DynamoDB::GlobalTable` resource configured for MREC with more than one entry in `Replicas`. For Multi-Region Strong Consistency (MRSC), Streams are not required and can be changed for existing tables.

## Syntax
<a name="aws-properties-dynamodb-globaltable-streamspecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-streamspecification-syntax.json"></a>

```
{
  "[StreamViewType](#cfn-dynamodb-globaltable-streamspecification-streamviewtype)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-streamspecification-syntax.yaml"></a>

```
  [StreamViewType](#cfn-dynamodb-globaltable-streamspecification-streamviewtype): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-streamspecification-properties"></a>

`StreamViewType`  <a name="cfn-dynamodb-globaltable-streamspecification-streamviewtype"></a>
 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.
*Required*: Yes  
*Type*: String  
*Allowed values*: `NEW_IMAGE | OLD_IMAGE | NEW_AND_OLD_IMAGES | KEYS_ONLY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable Tag
<a name="aws-properties-dynamodb-globaltable-tag"></a>

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. 

AWS-assigned tag names and values are automatically assigned the `aws:` prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix `user:` in the Cost Allocation Report. You cannot backdate the application of a tag.

For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*.

## Syntax
<a name="aws-properties-dynamodb-globaltable-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-tag-syntax.json"></a>

```
{
  "[Key](#cfn-dynamodb-globaltable-tag-key)" : String,
  "[Value](#cfn-dynamodb-globaltable-tag-value)" : String
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-tag-syntax.yaml"></a>

```
  [Key](#cfn-dynamodb-globaltable-tag-key): String
  [Value](#cfn-dynamodb-globaltable-tag-value): String
```

## Properties
<a name="aws-properties-dynamodb-globaltable-tag-properties"></a>

`Key`  <a name="cfn-dynamodb-globaltable-tag-key"></a>
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.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-dynamodb-globaltable-tag-value"></a>
The value of the tag. Tag values are case-sensitive and can be null.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable TargetTrackingScalingPolicyConfiguration
<a name="aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration"></a>

Defines a target tracking scaling policy.

## Syntax
<a name="aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-syntax.json"></a>

```
{
  "[DisableScaleIn](#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-disablescalein)" : Boolean,
  "[ScaleInCooldown](#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleincooldown)" : Integer,
  "[ScaleOutCooldown](#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleoutcooldown)" : Integer,
  "[TargetValue](#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-targetvalue)" : Number
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-syntax.yaml"></a>

```
  [DisableScaleIn](#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-disablescalein): Boolean
  [ScaleInCooldown](#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleincooldown): Integer
  [ScaleOutCooldown](#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleoutcooldown): Integer
  [TargetValue](#cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-targetvalue): Number
```

## Properties
<a name="aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-properties"></a>

`DisableScaleIn`  <a name="cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-disablescalein"></a>
Indicates whether scale in by the target tracking scaling policy is disabled. The default value is `false`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScaleInCooldown`  <a name="cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleincooldown"></a>
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScaleOutCooldown`  <a name="cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-scaleoutcooldown"></a>
The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetValue`  <a name="cfn-dynamodb-globaltable-targettrackingscalingpolicyconfiguration-targetvalue"></a>
Defines a target value for the scaling policy.  
*Required*: Yes  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable TimeToLiveSpecification
<a name="aws-properties-dynamodb-globaltable-timetolivespecification"></a>

Represents the settings used to enable or disable Time to Live (TTL) for the specified table. All replicas will have the same time to live configuration.

## Syntax
<a name="aws-properties-dynamodb-globaltable-timetolivespecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-timetolivespecification-syntax.json"></a>

```
{
  "[AttributeName](#cfn-dynamodb-globaltable-timetolivespecification-attributename)" : String,
  "[Enabled](#cfn-dynamodb-globaltable-timetolivespecification-enabled)" : Boolean
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-timetolivespecification-syntax.yaml"></a>

```
  [AttributeName](#cfn-dynamodb-globaltable-timetolivespecification-attributename): String
  [Enabled](#cfn-dynamodb-globaltable-timetolivespecification-enabled): Boolean
```

## Properties
<a name="aws-properties-dynamodb-globaltable-timetolivespecification-properties"></a>

`AttributeName`  <a name="cfn-dynamodb-globaltable-timetolivespecification-attributename"></a>
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.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enabled`  <a name="cfn-dynamodb-globaltable-timetolivespecification-enabled"></a>
Indicates whether TTL is to be enabled (true) or disabled (false) on the table.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable WarmThroughput
<a name="aws-properties-dynamodb-globaltable-warmthroughput"></a>

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the `UpdateTable` operation to meet the throughput requirements of an upcoming peak event.

## Syntax
<a name="aws-properties-dynamodb-globaltable-warmthroughput-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-warmthroughput-syntax.json"></a>

```
{
  "[ReadUnitsPerSecond](#cfn-dynamodb-globaltable-warmthroughput-readunitspersecond)" : Integer,
  "[WriteUnitsPerSecond](#cfn-dynamodb-globaltable-warmthroughput-writeunitspersecond)" : Integer
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-warmthroughput-syntax.yaml"></a>

```
  [ReadUnitsPerSecond](#cfn-dynamodb-globaltable-warmthroughput-readunitspersecond): Integer
  [WriteUnitsPerSecond](#cfn-dynamodb-globaltable-warmthroughput-writeunitspersecond): Integer
```

## Properties
<a name="aws-properties-dynamodb-globaltable-warmthroughput-properties"></a>

`ReadUnitsPerSecond`  <a name="cfn-dynamodb-globaltable-warmthroughput-readunitspersecond"></a>
Represents the number of read operations your base table can instantaneously support.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WriteUnitsPerSecond`  <a name="cfn-dynamodb-globaltable-warmthroughput-writeunitspersecond"></a>
Represents the number of write operations your base table can instantaneously support.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable WriteOnDemandThroughputSettings
<a name="aws-properties-dynamodb-globaltable-writeondemandthroughputsettings"></a>

Sets the write request settings for a global table or a global secondary index. You can only specify this setting if your resource uses the `PAY_PER_REQUEST``BillingMode`.

## Syntax
<a name="aws-properties-dynamodb-globaltable-writeondemandthroughputsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-writeondemandthroughputsettings-syntax.json"></a>

```
{
  "[MaxWriteRequestUnits](#cfn-dynamodb-globaltable-writeondemandthroughputsettings-maxwriterequestunits)" : Integer
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-writeondemandthroughputsettings-syntax.yaml"></a>

```
  [MaxWriteRequestUnits](#cfn-dynamodb-globaltable-writeondemandthroughputsettings-maxwriterequestunits): Integer
```

## Properties
<a name="aws-properties-dynamodb-globaltable-writeondemandthroughputsettings-properties"></a>

`MaxWriteRequestUnits`  <a name="cfn-dynamodb-globaltable-writeondemandthroughputsettings-maxwriterequestunits"></a>
Maximum number of write request settings for the specified replica of a global table.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DynamoDB::GlobalTable WriteProvisionedThroughputSettings
<a name="aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings"></a>

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`.

## Syntax
<a name="aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings-syntax.json"></a>

```
{
  "[WriteCapacityAutoScalingSettings](#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings-writecapacityautoscalingsettings)" : CapacityAutoScalingSettings
}
```

### YAML
<a name="aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings-syntax.yaml"></a>

```
  [WriteCapacityAutoScalingSettings](#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings-writecapacityautoscalingsettings): 
    CapacityAutoScalingSettings
```

## Properties
<a name="aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings-properties"></a>

`WriteCapacityAutoScalingSettings`  <a name="cfn-dynamodb-globaltable-writeprovisionedthroughputsettings-writecapacityautoscalingsettings"></a>
Specifies auto scaling settings for the replica table or global secondary index.  
*Required*: No  
*Type*: [CapacityAutoScalingSettings](aws-properties-dynamodb-globaltable-capacityautoscalingsettings.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)