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::Table The `AWS::DynamoDB::Table` resource creates a DynamoDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *Amazon DynamoDB API Reference*. You should be aware of the following behaviors when working with DynamoDB tables: + AWS CloudFormation typically creates DynamoDB tables in parallel. However, if your template includes multiple DynamoDB tables with indexes, you must declare dependencies so that the tables are created sequentially. Amazon DynamoDB limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DynamoDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute). **Important** Our guidance is to use the latest schema documented for your AWS CloudFormation templates. This schema supports the provisioning of all table settings below. When using this schema in your AWS CloudFormation templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DynamoDB::Table", "Properties" : { "[AttributeDefinitions](#cfn-dynamodb-table-attributedefinitions)" : [ AttributeDefinition, ... ], "[BillingMode](#cfn-dynamodb-table-billingmode)" : String, "[ContributorInsightsSpecification](#cfn-dynamodb-table-contributorinsightsspecification)" : ContributorInsightsSpecification, "[DeletionProtectionEnabled](#cfn-dynamodb-table-deletionprotectionenabled)" : Boolean, "[GlobalSecondaryIndexes](#cfn-dynamodb-table-globalsecondaryindexes)" : [ GlobalSecondaryIndex, ... ], "[ImportSourceSpecification](#cfn-dynamodb-table-importsourcespecification)" : ImportSourceSpecification, "[KeySchema](#cfn-dynamodb-table-keyschema)" : [ KeySchema, ... ], "[KinesisStreamSpecification](#cfn-dynamodb-table-kinesisstreamspecification)" : KinesisStreamSpecification, "[LocalSecondaryIndexes](#cfn-dynamodb-table-localsecondaryindexes)" : [ LocalSecondaryIndex, ... ], "[OnDemandThroughput](#cfn-dynamodb-table-ondemandthroughput)" : OnDemandThroughput, "[PointInTimeRecoverySpecification](#cfn-dynamodb-table-pointintimerecoveryspecification)" : PointInTimeRecoverySpecification, "[ProvisionedThroughput](#cfn-dynamodb-table-provisionedthroughput)" : ProvisionedThroughput, "[ResourcePolicy](#cfn-dynamodb-table-resourcepolicy)" : ResourcePolicy, "[SSESpecification](#cfn-dynamodb-table-ssespecification)" : SSESpecification, "[StreamSpecification](#cfn-dynamodb-table-streamspecification)" : StreamSpecification, "[TableClass](#cfn-dynamodb-table-tableclass)" : String, "[TableName](#cfn-dynamodb-table-tablename)" : String, "[Tags](#cfn-dynamodb-table-tags)" : [ Tag, ... ], "[TimeToLiveSpecification](#cfn-dynamodb-table-timetolivespecification)" : TimeToLiveSpecification, "[WarmThroughput](#cfn-dynamodb-table-warmthroughput)" : WarmThroughput } } ``` ### YAML ``` Type: AWS::DynamoDB::Table Properties: [AttributeDefinitions](#cfn-dynamodb-table-attributedefinitions): - AttributeDefinition [BillingMode](#cfn-dynamodb-table-billingmode): String [ContributorInsightsSpecification](#cfn-dynamodb-table-contributorinsightsspecification): ContributorInsightsSpecification [DeletionProtectionEnabled](#cfn-dynamodb-table-deletionprotectionenabled): Boolean [GlobalSecondaryIndexes](#cfn-dynamodb-table-globalsecondaryindexes): - GlobalSecondaryIndex [ImportSourceSpecification](#cfn-dynamodb-table-importsourcespecification): ImportSourceSpecification [KeySchema](#cfn-dynamodb-table-keyschema): - KeySchema [KinesisStreamSpecification](#cfn-dynamodb-table-kinesisstreamspecification): KinesisStreamSpecification [LocalSecondaryIndexes](#cfn-dynamodb-table-localsecondaryindexes): - LocalSecondaryIndex [OnDemandThroughput](#cfn-dynamodb-table-ondemandthroughput): OnDemandThroughput [PointInTimeRecoverySpecification](#cfn-dynamodb-table-pointintimerecoveryspecification): PointInTimeRecoverySpecification [ProvisionedThroughput](#cfn-dynamodb-table-provisionedthroughput): ProvisionedThroughput [ResourcePolicy](#cfn-dynamodb-table-resourcepolicy): ResourcePolicy [SSESpecification](#cfn-dynamodb-table-ssespecification): SSESpecification [StreamSpecification](#cfn-dynamodb-table-streamspecification): StreamSpecification [TableClass](#cfn-dynamodb-table-tableclass): String [TableName](#cfn-dynamodb-table-tablename): String [Tags](#cfn-dynamodb-table-tags): - Tag [TimeToLiveSpecification](#cfn-dynamodb-table-timetolivespecification): TimeToLiveSpecification [WarmThroughput](#cfn-dynamodb-table-warmthroughput): WarmThroughput ``` ## Properties `AttributeDefinitions` A list of attributes that describe the key schema for the table and indexes. This property is required to create a DynamoDB table. Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition. *Required*: Conditional *Type*: Array of [AttributeDefinition](aws-properties-dynamodb-table-attributedefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BillingMode` Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: + `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for most DynamoDB workloads. `PAY_PER_REQUEST` sets the billing mode to [On-demand capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html). + `PROVISIONED` - We recommend using `PROVISIONED` for steady workloads with predictable growth where capacity requirements can be reliably forecasted. `PROVISIONED` sets the billing mode to [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html). If not specified, the default 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) `ContributorInsightsSpecification` The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor. *Required*: No *Type*: [ContributorInsightsSpecification](aws-properties-dynamodb-table-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` Determines if a table 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` Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is `ACTIVE`. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. If you add or delete an index 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 index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. *Required*: No *Type*: Array of [GlobalSecondaryIndex](aws-properties-dynamodb-table-globalsecondaryindex.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ImportSourceSpecification` Specifies the properties of data being imported from the S3 bucket source to the" table. If you specify the `ImportSourceSpecification` property, and also specify either the `StreamSpecification`, the `TableClass` property, the `DeletionProtectionEnabled` property, or the `WarmThroughput` property, the IAM entity creating/updating stack must have `UpdateTable` permission. *Required*: No *Type*: [ImportSourceSpecification](aws-properties-dynamodb-table-importsourcespecification.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `KeySchema` 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*: Yes *Type*: [Array](aws-properties-dynamodb-table-keyschema.md) of [KeySchema](aws-properties-dynamodb-table-keyschema.md) *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `KinesisStreamSpecification` The Kinesis Data Streams configuration for the specified table. *Required*: No *Type*: [KinesisStreamSpecification](aws-properties-dynamodb-table-kinesisstreamspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LocalSecondaryIndexes` Local secondary indexes to be created on the table. You can create up to 5 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. *Required*: No *Type*: Array of [LocalSecondaryIndex](aws-properties-dynamodb-table-localsecondaryindex.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OnDemandThroughput` Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both. *Required*: No *Type*: [OnDemandThroughput](aws-properties-dynamodb-table-ondemandthroughput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PointInTimeRecoverySpecification` The settings used to enable point in time recovery. *Required*: No *Type*: [PointInTimeRecoverySpecification](aws-properties-dynamodb-table-pointintimerecoveryspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProvisionedThroughput` Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). If you set `BillingMode` as `PROVISIONED`, you must specify this property. If you set `BillingMode` as `PAY_PER_REQUEST`, you cannot specify this property. *Required*: Conditional *Type*: [ProvisionedThroughput](aws-properties-dynamodb-table-provisionedthroughput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResourcePolicy` An AWS resource-based policy document in JSON format that will be attached to the table. When you attach a resource-based policy while creating a table, the policy application is *strongly consistent*. The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). You need to specify the `CreateTable` and `PutResourcePolicy` IAM actions for authorizing a user to create a table with a resource-based policy. *Required*: No *Type*: [ResourcePolicy](aws-properties-dynamodb-table-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` Specifies the settings to enable server-side encryption. *Required*: No *Type*: [SSESpecification](aws-properties-dynamodb-table-ssespecification.md) *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `StreamSpecification` The settings for the DynamoDB table stream, which captures changes to items stored in the table. Including this property in your AWS CloudFormation template automatically enables streaming. *Required*: No *Type*: [StreamSpecification](aws-properties-dynamodb-table-streamspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TableClass` The table class of the new 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) `TableName` A name for the table. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for 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 *Minimum*: `1` *Maximum*: `1024` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` An array of key-value pairs to apply to this resource. 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-table-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeToLiveSpecification` Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide. *Required*: No *Type*: [TimeToLiveSpecification](aws-properties-dynamodb-table-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` Represents the warm throughput (in read units per second and write units per second) for creating a table. *Required*: No *Type*: [WarmThroughput](aws-properties-dynamodb-table-warmthroughput.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 ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example: `{ "Ref": "myDynamoDBTable" }` For the resource with the logical ID `myDynamoDBTable`, `Ref` will return the DynamoDB 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 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). #### `Arn` The Amazon Resource Name (ARN) of the DynamoDB table, such as `arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable`. `StreamArn` 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`. You must specify the `StreamSpecification` property to use this attribute. ## Examples **Topics** + [DynamoDB Table with Local and Secondary Indexes](#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_Local_and_Secondary_Indexes) + [DynamoDB Table with a DependsOn Attribute](#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute) + [DynamoDB Table with Application Auto Scaling](#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_Application_Auto_Scaling) ### DynamoDB Table with Local and Secondary Indexes The following sample creates a DynamoDB table with `Album`, `Artist`, `Sales`, `NumberOfSongs` as attributes. The primary key includes the `Album` attribute as the hash key and `Artist` attribute as the range key. The table also includes two global and one secondary index. For querying the number of sales for a given artist, the global secondary index uses the `Sales` attribute as the hash key and the `Artist` attribute as the range key. For querying the sales based on the number of songs, the global secondary index uses the `NumberOfSongs` attribute as the hash key and the `Sales` attribute as the range key. For querying the sales of an album, the local secondary index uses the same hash key as the table but uses the `Sales` attribute as the range key. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "myDynamoDBTable": { "Type": "AWS::DynamoDB::Table", "Properties": { "AttributeDefinitions": [ { "AttributeName": "Album", "AttributeType": "S" }, { "AttributeName": "Artist", "AttributeType": "S" }, { "AttributeName": "Sales", "AttributeType": "N" }, { "AttributeName": "NumberOfSongs", "AttributeType": "N" } ], "KeySchema": [ { "AttributeName": "Album", "KeyType": "HASH" }, { "AttributeName": "Artist", "KeyType": "RANGE" } ], "ProvisionedThroughput": { "ReadCapacityUnits": "5", "WriteCapacityUnits": "5" }, "TableName": "myTableName", "GlobalSecondaryIndexes": [ { "IndexName": "myGSI", "KeySchema": [ { "AttributeName": "Sales", "KeyType": "HASH" }, { "AttributeName": "Artist", "KeyType": "RANGE" } ], "Projection": { "NonKeyAttributes": [ "Album", "NumberOfSongs" ], "ProjectionType": "INCLUDE" }, "ProvisionedThroughput": { "ReadCapacityUnits": "5", "WriteCapacityUnits": "5" } }, { "IndexName": "myGSI2", "KeySchema": [ { "AttributeName": "NumberOfSongs", "KeyType": "HASH" }, { "AttributeName": "Sales", "KeyType": "RANGE" } ], "Projection": { "NonKeyAttributes": [ "Album", "Artist" ], "ProjectionType": "INCLUDE" }, "ProvisionedThroughput": { "ReadCapacityUnits": "5", "WriteCapacityUnits": "5" } } ], "LocalSecondaryIndexes": [ { "IndexName": "myLSI", "KeySchema": [ { "AttributeName": "Album", "KeyType": "HASH" }, { "AttributeName": "Sales", "KeyType": "RANGE" } ], "Projection": { "NonKeyAttributes": [ "Artist", "NumberOfSongs" ], "ProjectionType": "INCLUDE" } } ] } } } } ``` #### YAML ``` AWSTemplateFormatVersion: '2010-09-09' Resources: myDynamoDBTable: Type: AWS::DynamoDB::Table Properties: AttributeDefinitions: - AttributeName: Album AttributeType: S - AttributeName: Artist AttributeType: S - AttributeName: Sales AttributeType: 'N' - AttributeName: NumberOfSongs AttributeType: 'N' KeySchema: - AttributeName: Album KeyType: HASH - AttributeName: Artist KeyType: RANGE ProvisionedThroughput: ReadCapacityUnits: '5' WriteCapacityUnits: '5' TableName: myTableName GlobalSecondaryIndexes: - IndexName: myGSI KeySchema: - AttributeName: Sales KeyType: HASH - AttributeName: Artist KeyType: RANGE Projection: NonKeyAttributes: - Album - NumberOfSongs ProjectionType: INCLUDE ProvisionedThroughput: ReadCapacityUnits: '5' WriteCapacityUnits: '5' - IndexName: myGSI2 KeySchema: - AttributeName: NumberOfSongs KeyType: HASH - AttributeName: Sales KeyType: RANGE Projection: NonKeyAttributes: - Album - Artist ProjectionType: INCLUDE ProvisionedThroughput: ReadCapacityUnits: '5' WriteCapacityUnits: '5' LocalSecondaryIndexes: - IndexName: myLSI KeySchema: - AttributeName: Album KeyType: HASH - AttributeName: Sales KeyType: RANGE Projection: NonKeyAttributes: - Artist - NumberOfSongs ProjectionType: INCLUDE ``` ### DynamoDB Table with a DependsOn Attribute If you include multiple DynamoDB tables with indexes in a single template, you must include dependencies so that the tables are created sequentially. DynamoDB limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DynamoDB returns an error and the stack operation fails. The following sample assumes that the `myFirstDDBTable` table is declared in the same template as the `mySecondDDBTable` table, and both tables include a secondary index. The `mySecondDDBTable` table includes a dependency on the `myFirstDDBTable` table so that AWS CloudFormation creates the tables one at a time. #### JSON ``` { "mySecondDDBTable": { "Type": "AWS::DynamoDB::Table", "DependsOn": "myFirstDDBTable", "Properties": { "AttributeDefinitions": [ { "AttributeName": "ArtistId", "AttributeType": "S" }, { "AttributeName": "Concert", "AttributeType": "S" }, { "AttributeName": "TicketSales", "AttributeType": "S" } ], "KeySchema": [ { "AttributeName": "ArtistId", "KeyType": "HASH" }, { "AttributeName": "Concert", "KeyType": "RANGE" } ], "ProvisionedThroughput": { "ReadCapacityUnits": { "Ref": "ReadCapacityUnits" }, "WriteCapacityUnits": { "Ref": "WriteCapacityUnits" } }, "GlobalSecondaryIndexes": [ { "IndexName": "myGSI", "KeySchema": [ { "AttributeName": "TicketSales", "KeyType": "HASH" } ], "Projection": { "ProjectionType": "KEYS_ONLY" }, "ProvisionedThroughput": { "ReadCapacityUnits": { "Ref": "ReadCapacityUnits" }, "WriteCapacityUnits": { "Ref": "WriteCapacityUnits" } } } ], "Tags": [ { "Key": "foo", "Value": "bar" } ] } } } ``` #### YAML ``` mySecondDDBTable: Type: AWS::DynamoDB::Table DependsOn: myFirstDDBTable Properties: AttributeDefinitions: - AttributeName: ArtistId AttributeType: S - AttributeName: Concert AttributeType: S - AttributeName: TicketSales AttributeType: S KeySchema: - AttributeName: ArtistId KeyType: HASH - AttributeName: Concert KeyType: RANGE ProvisionedThroughput: ReadCapacityUnits: !Ref ReadCapacityUnits WriteCapacityUnits: !Ref WriteCapacityUnits GlobalSecondaryIndexes: - IndexName: myGSI KeySchema: - AttributeName: TicketSales KeyType: HASH Projection: ProjectionType: KEYS_ONLY ProvisionedThroughput: ReadCapacityUnits: !Ref ReadCapacityUnits WriteCapacityUnits: !Ref WriteCapacityUnits Tags: - Key: foo Value: bar ``` ### DynamoDB Table with Application Auto Scaling This example sets up Application Auto Scaling for a `AWS::DynamoDB::Table` resource. The template defines a `TargetTrackingScaling` scaling policy that scales up the `WriteCapacityUnits` throughput for the table. #### JSON ``` { "Resources": { "DDBTable": { "Type": "AWS::DynamoDB::Table", "Properties": { "AttributeDefinitions": [ { "AttributeName": "ArtistId", "AttributeType": "S" }, { "AttributeName": "Concert", "AttributeType": "S" }, { "AttributeName": "TicketSales", "AttributeType": "S" } ], "KeySchema": [ { "AttributeName": "ArtistId", "KeyType": "HASH" }, { "AttributeName": "Concert", "KeyType": "RANGE" } ], "GlobalSecondaryIndexes": [ { "IndexName": "GSI", "KeySchema": [ { "AttributeName": "TicketSales", "KeyType": "HASH" } ], "Projection": { "ProjectionType": "KEYS_ONLY" }, "ProvisionedThroughput": { "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 } } ], "ProvisionedThroughput": { "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 } } }, "WriteCapacityScalableTarget": { "Type": "AWS::ApplicationAutoScaling::ScalableTarget", "Properties": { "MaxCapacity": 15, "MinCapacity": 5, "ResourceId": { "Fn::Join": [ "/", [ "table", { "Ref": "DDBTable" } ] ] }, "RoleARN": { "Fn::GetAtt": ["ScalingRole", "Arn"] }, "ScalableDimension": "dynamodb:table:WriteCapacityUnits", "ServiceNamespace": "dynamodb" } }, "ScalingRole": { "Type": "AWS::IAM::Role", "Properties": { "AssumeRolePolicyDocument": { "Version": "2012-10-17" , "Statement": [ { "Effect": "Allow", "Principal": { "Service": [ "application-autoscaling.amazonaws.com" ] }, "Action": [ "sts:AssumeRole" ] } ] }, "Path": "/", "Policies": [ { "PolicyName": "root", "PolicyDocument": { "Version": "2012-10-17" , "Statement": [ { "Effect": "Allow", "Action": [ "dynamodb:DescribeTable", "dynamodb:UpdateTable", "cloudwatch:PutMetricAlarm", "cloudwatch:DescribeAlarms", "cloudwatch:GetMetricStatistics", "cloudwatch:SetAlarmState", "cloudwatch:DeleteAlarms" ], "Resource": "*" } ] } } ] } }, "WriteScalingPolicy": { "Type": "AWS::ApplicationAutoScaling::ScalingPolicy", "Properties": { "PolicyName": "WriteAutoScalingPolicy", "PolicyType": "TargetTrackingScaling", "ScalingTargetId": { "Ref": "WriteCapacityScalableTarget" }, "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 50.0, "ScaleInCooldown": 60, "ScaleOutCooldown": 60, "PredefinedMetricSpecification": { "PredefinedMetricType": "DynamoDBWriteCapacityUtilization" } } } } } } ``` #### YAML ``` Resources: DDBTable: Type: AWS::DynamoDB::Table Properties: AttributeDefinitions: - AttributeName: "ArtistId" AttributeType: "S" - AttributeName: "Concert" AttributeType: "S" - AttributeName: "TicketSales" AttributeType: "S" KeySchema: - AttributeName: "ArtistId" KeyType: "HASH" - AttributeName: "Concert" KeyType: "RANGE" GlobalSecondaryIndexes: - IndexName: "GSI" KeySchema: - AttributeName: "TicketSales" KeyType: "HASH" Projection: ProjectionType: "KEYS_ONLY" ProvisionedThroughput: ReadCapacityUnits: 5 WriteCapacityUnits: 5 ProvisionedThroughput: ReadCapacityUnits: 5 WriteCapacityUnits: 5 WriteCapacityScalableTarget: Type: AWS::ApplicationAutoScaling::ScalableTarget Properties: MaxCapacity: 15 MinCapacity: 5 ResourceId: !Join - / - - table - !Ref DDBTable RoleARN: !GetAtt ScalingRole.Arn ScalableDimension: dynamodb:table:WriteCapacityUnits ServiceNamespace: dynamodb ScalingRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Version: "2012-10-17" Statement: - Effect: "Allow" Principal: Service: - application-autoscaling.amazonaws.com Action: - "sts:AssumeRole" Path: "/" Policies: - PolicyName: "root" PolicyDocument: Version: "2012-10-17" Statement: - Effect: "Allow" Action: - "dynamodb:DescribeTable" - "dynamodb:UpdateTable" - "cloudwatch:PutMetricAlarm" - "cloudwatch:DescribeAlarms" - "cloudwatch:GetMetricStatistics" - "cloudwatch:SetAlarmState" - "cloudwatch:DeleteAlarms" Resource: "*" WriteScalingPolicy: Type: AWS::ApplicationAutoScaling::ScalingPolicy Properties: PolicyName: WriteAutoScalingPolicy PolicyType: TargetTrackingScaling ScalingTargetId: !Ref WriteCapacityScalableTarget TargetTrackingScalingPolicyConfiguration: TargetValue: 50.0 ScaleInCooldown: 60 ScaleOutCooldown: 60 PredefinedMetricSpecification: PredefinedMetricType: DynamoDBWriteCapacityUtilization ``` # AWS::DynamoDB::Table AttributeDefinition Represents an attribute for describing the schema for the table and indexes. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AttributeName](#cfn-dynamodb-table-attributedefinition-attributename)" : String, "[AttributeType](#cfn-dynamodb-table-attributedefinition-attributetype)" : String } ``` ### YAML ``` [AttributeName](#cfn-dynamodb-table-attributedefinition-attributename): String [AttributeType](#cfn-dynamodb-table-attributedefinition-attributetype): String ``` ## Properties `AttributeName` 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` 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::Table ContributorInsightsSpecification Configures contributor insights settings for a table or one of its indexes. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Enabled](#cfn-dynamodb-table-contributorinsightsspecification-enabled)" : Boolean, "[Mode](#cfn-dynamodb-table-contributorinsightsspecification-mode)" : String } ``` ### YAML ``` [Enabled](#cfn-dynamodb-table-contributorinsightsspecification-enabled): Boolean [Mode](#cfn-dynamodb-table-contributorinsightsspecification-mode): String ``` ## Properties `Enabled` 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` Specifies the CloudWatch Contributor Insights mode for a 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 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::Table Csv The options for imported source files in CSV format. The values are Delimiter and HeaderList. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Delimiter](#cfn-dynamodb-table-csv-delimiter)" : String, "[HeaderList](#cfn-dynamodb-table-csv-headerlist)" : [ String, ... ] } ``` ### YAML ``` [Delimiter](#cfn-dynamodb-table-csv-delimiter): String [HeaderList](#cfn-dynamodb-table-csv-headerlist): - String ``` ## Properties `Delimiter` The delimiter used for separating items in the CSV file being imported. *Required*: No *Type*: String *Pattern*: `[,;:|\t ]` *Minimum*: `1` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `HeaderList` List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header. *Required*: No *Type*: Array of 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) # AWS::DynamoDB::Table GlobalSecondaryIndex Represents the properties of a global secondary index. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ContributorInsightsSpecification](#cfn-dynamodb-table-globalsecondaryindex-contributorinsightsspecification)" : ContributorInsightsSpecification, "[IndexName](#cfn-dynamodb-table-globalsecondaryindex-indexname)" : String, "[KeySchema](#cfn-dynamodb-table-globalsecondaryindex-keyschema)" : [ KeySchema, ... ], "[OnDemandThroughput](#cfn-dynamodb-table-globalsecondaryindex-ondemandthroughput)" : OnDemandThroughput, "[Projection](#cfn-dynamodb-table-globalsecondaryindex-projection)" : Projection, "[ProvisionedThroughput](#cfn-dynamodb-table-globalsecondaryindex-provisionedthroughput)" : ProvisionedThroughput, "[WarmThroughput](#cfn-dynamodb-table-globalsecondaryindex-warmthroughput)" : WarmThroughput } ``` ### YAML ``` [ContributorInsightsSpecification](#cfn-dynamodb-table-globalsecondaryindex-contributorinsightsspecification): ContributorInsightsSpecification [IndexName](#cfn-dynamodb-table-globalsecondaryindex-indexname): String [KeySchema](#cfn-dynamodb-table-globalsecondaryindex-keyschema): - KeySchema [OnDemandThroughput](#cfn-dynamodb-table-globalsecondaryindex-ondemandthroughput): OnDemandThroughput [Projection](#cfn-dynamodb-table-globalsecondaryindex-projection): Projection [ProvisionedThroughput](#cfn-dynamodb-table-globalsecondaryindex-provisionedthroughput): ProvisionedThroughput [WarmThroughput](#cfn-dynamodb-table-globalsecondaryindex-warmthroughput): WarmThroughput ``` ## Properties `ContributorInsightsSpecification` The settings used to specify whether to enable CloudWatch Contributor Insights for the global table and define which events to monitor. *Required*: No *Type*: [ContributorInsightsSpecification](aws-properties-dynamodb-table-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` The name of the global secondary index. The name must be unique among all other indexes on this table. *Required*: Yes *Type*: String *Pattern*: `[a-zA-Z0-9_.-]+` *Minimum*: `3` *Maximum*: `255` *Update requires*: Updates are not supported. `KeySchema` 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-table-keyschema.md) of [KeySchema](aws-properties-dynamodb-table-keyschema.md) *Minimum*: `1` *Update requires*: Updates are not supported. `OnDemandThroughput` The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both. You must use either `OnDemandThroughput` or `ProvisionedThroughput` based on your table's capacity mode. *Required*: No *Type*: [OnDemandThroughput](aws-properties-dynamodb-table-ondemandthroughput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Projection` 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-table-projection.md) *Update requires*: Updates are not supported. `ProvisionedThroughput` Represents the provisioned throughput settings for the specified global secondary index. You must use either `OnDemandThroughput` or `ProvisionedThroughput` based on your table's capacity mode. For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*. *Required*: No *Type*: [ProvisionedThroughput](aws-properties-dynamodb-table-provisionedthroughput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WarmThroughput` 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-table-warmthroughput.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::Table ImportSourceSpecification Specifies the properties of data being imported from the S3 bucket source to the table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputCompressionType](#cfn-dynamodb-table-importsourcespecification-inputcompressiontype)" : String, "[InputFormat](#cfn-dynamodb-table-importsourcespecification-inputformat)" : String, "[InputFormatOptions](#cfn-dynamodb-table-importsourcespecification-inputformatoptions)" : InputFormatOptions, "[S3BucketSource](#cfn-dynamodb-table-importsourcespecification-s3bucketsource)" : S3BucketSource } ``` ### YAML ``` [InputCompressionType](#cfn-dynamodb-table-importsourcespecification-inputcompressiontype): String [InputFormat](#cfn-dynamodb-table-importsourcespecification-inputformat): String [InputFormatOptions](#cfn-dynamodb-table-importsourcespecification-inputformatoptions): InputFormatOptions [S3BucketSource](#cfn-dynamodb-table-importsourcespecification-s3bucketsource): S3BucketSource ``` ## Properties `InputCompressionType` Type of compression to be used on the input coming from the imported table. *Required*: No *Type*: String *Allowed values*: `GZIP | ZSTD | NONE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `InputFormat` The format of the source data. Valid values for `ImportFormat` are `CSV`, `DYNAMODB_JSON` or `ION`. *Required*: Yes *Type*: String *Allowed values*: `DYNAMODB_JSON | ION | CSV` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `InputFormatOptions` Additional properties that specify how the input is formatted, *Required*: No *Type*: [InputFormatOptions](aws-properties-dynamodb-table-inputformatoptions.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `S3BucketSource` The S3 bucket that provides the source for the import. *Required*: Yes *Type*: [S3BucketSource](aws-properties-dynamodb-table-s3bucketsource.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DynamoDB::Table InputFormatOptions The format options for the data that was imported into the target table. There is one value, CsvOption. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Csv](#cfn-dynamodb-table-inputformatoptions-csv)" : Csv } ``` ### YAML ``` [Csv](#cfn-dynamodb-table-inputformatoptions-csv): Csv ``` ## Properties `Csv` The options for imported source files in CSV format. The values are Delimiter and HeaderList. *Required*: No *Type*: [Csv](aws-properties-dynamodb-table-csv.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DynamoDB::Table KeySchema 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 To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AttributeName](#cfn-dynamodb-table-keyschema-attributename)" : String, "[KeyType](#cfn-dynamodb-table-keyschema-keytype)" : String } ``` ### YAML ``` [AttributeName](#cfn-dynamodb-table-keyschema-attributename): String [KeyType](#cfn-dynamodb-table-keyschema-keytype): String ``` ## Properties `AttributeName` The name of a key attribute. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `KeyType` 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*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) ## See also For an example of a declared key schema, see [AWS::DynamoDB::Table](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html). # AWS::DynamoDB::Table KinesisStreamSpecification The Kinesis Data Streams configuration for the specified table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApproximateCreationDateTimePrecision](#cfn-dynamodb-table-kinesisstreamspecification-approximatecreationdatetimeprecision)" : String, "[StreamArn](#cfn-dynamodb-table-kinesisstreamspecification-streamarn)" : String } ``` ### YAML ``` [ApproximateCreationDateTimePrecision](#cfn-dynamodb-table-kinesisstreamspecification-approximatecreationdatetimeprecision): String [StreamArn](#cfn-dynamodb-table-kinesisstreamspecification-streamarn): String ``` ## Properties `ApproximateCreationDateTimePrecision` 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` The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024. *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) ## See also + [Change Data Capture for Kinesis Data Streams with DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/kds.html) # AWS::DynamoDB::Table LocalSecondaryIndex Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IndexName](#cfn-dynamodb-table-localsecondaryindex-indexname)" : String, "[KeySchema](#cfn-dynamodb-table-localsecondaryindex-keyschema)" : [ KeySchema, ... ], "[Projection](#cfn-dynamodb-table-localsecondaryindex-projection)" : Projection } ``` ### YAML ``` [IndexName](#cfn-dynamodb-table-localsecondaryindex-indexname): String [KeySchema](#cfn-dynamodb-table-localsecondaryindex-keyschema): - KeySchema [Projection](#cfn-dynamodb-table-localsecondaryindex-projection): Projection ``` ## Properties `IndexName` The name of the local secondary index. The name must be unique among all other indexes on this table. *Required*: Yes *Type*: String *Pattern*: `[a-zA-Z0-9_.-]+` *Minimum*: `3` *Maximum*: `255` *Update requires*: Updates are not supported. `KeySchema` 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-table-keyschema.md) of [KeySchema](aws-properties-dynamodb-table-keyschema.md) *Minimum*: `1` *Update requires*: Updates are not supported. `Projection` 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-table-projection.md) *Update requires*: Updates are not supported. ## See also For an example of a declared local secondary index, see [AWS::DynamoDB::Table](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html). # AWS::DynamoDB::Table OnDemandThroughput Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxReadRequestUnits](#cfn-dynamodb-table-ondemandthroughput-maxreadrequestunits)" : Integer, "[MaxWriteRequestUnits](#cfn-dynamodb-table-ondemandthroughput-maxwriterequestunits)" : Integer } ``` ### YAML ``` [MaxReadRequestUnits](#cfn-dynamodb-table-ondemandthroughput-maxreadrequestunits): Integer [MaxWriteRequestUnits](#cfn-dynamodb-table-ondemandthroughput-maxwriterequestunits): Integer ``` ## Properties `MaxReadRequestUnits` Maximum number of read request units for the specified table. To specify a maximum `OnDemandThroughput` on your table, set the value of `MaxReadRequestUnits` as greater than or equal to 1. To remove the maximum `OnDemandThroughput` that is currently set on your table, set the value of `MaxReadRequestUnits` to -1. *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) `MaxWriteRequestUnits` Maximum number of write request units for the specified table. To specify a maximum `OnDemandThroughput` on your table, set the value of `MaxWriteRequestUnits` as greater than or equal to 1. To remove the maximum `OnDemandThroughput` that is currently set on your table, set the value of `MaxWriteRequestUnits` to -1. *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::Table PointInTimeRecoverySpecification The settings used to enable point in time recovery. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PointInTimeRecoveryEnabled](#cfn-dynamodb-table-pointintimerecoveryspecification-pointintimerecoveryenabled)" : Boolean, "[RecoveryPeriodInDays](#cfn-dynamodb-table-pointintimerecoveryspecification-recoveryperiodindays)" : Integer } ``` ### YAML ``` [PointInTimeRecoveryEnabled](#cfn-dynamodb-table-pointintimerecoveryspecification-pointintimerecoveryenabled): Boolean [RecoveryPeriodInDays](#cfn-dynamodb-table-pointintimerecoveryspecification-recoveryperiodindays): Integer ``` ## Properties `PointInTimeRecoveryEnabled` 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` 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) ## See also [PointInTimeRecoverySpecification](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PointInTimeRecoverySpecification.html) in the Amazon DynamoDB API Reference. # AWS::DynamoDB::Table Projection 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 To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[NonKeyAttributes](#cfn-dynamodb-table-projection-nonkeyattributes)" : [ String, ... ], "[ProjectionType](#cfn-dynamodb-table-projection-projectiontype)" : String } ``` ### YAML ``` [NonKeyAttributes](#cfn-dynamodb-table-projection-nonkeyattributes): - String [ProjectionType](#cfn-dynamodb-table-projection-projectiontype): String ``` ## Properties `NonKeyAttributes` 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 *Minimum*: `1` *Maximum*: `20` *Update requires*: Updates are not supported. `ProjectionType` 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*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DynamoDB::Table ProvisionedThroughput Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReadCapacityUnits](#cfn-dynamodb-table-provisionedthroughput-readcapacityunits)" : Integer, "[WriteCapacityUnits](#cfn-dynamodb-table-provisionedthroughput-writecapacityunits)" : Integer } ``` ### YAML ``` [ReadCapacityUnits](#cfn-dynamodb-table-provisionedthroughput-readcapacityunits): Integer [WriteCapacityUnits](#cfn-dynamodb-table-provisionedthroughput-writecapacityunits): Integer ``` ## Properties `ReadCapacityUnits` The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0. *Required*: Yes *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WriteCapacityUnits` The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0. *Required*: Yes *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DynamoDB::Table ResourcePolicy 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. For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PolicyDocument](#cfn-dynamodb-table-resourcepolicy-policydocument)" : Json } ``` ### YAML ``` [PolicyDocument](#cfn-dynamodb-table-resourcepolicy-policydocument): Json ``` ## Properties `PolicyDocument` A resource-based policy document that contains permissions to add to the specified DynamoDB table, index, or both. 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 ### Attaching a resource-based policy to a DynamoDB table and its stream The following CloudFormation template creates a table named `MusicCollectionTable` and attaches a resource-based policy to this table. 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 ``` { "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "MusicCollectionTable": { "Type": "AWS::DynamoDB::Table", "Properties": { "AttributeDefinitions": [ { "AttributeName": "Artist", "AttributeType": "S" } ], "KeySchema": [ { "AttributeName": "Artist", "KeyType": "HASH" } ], "BillingMode": "PROVISIONED", "ProvisionedThroughput": { "ReadCapacityUnits": 5, "WriteCapacityUnits": 5 }, "StreamSpecification": { "StreamViewType": "OLD_IMAGE", "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": "*" } ] } } }, "TableName": "MusicCollection", "ResourcePolicy": { "PolicyDocument": { "Version": "2012-10-17", "Statement": [ { "Principal": { "AWS": [ "arn:aws:iam::111122223333:user/foobar" ] }, "Effect": "Allow", "Action": "dynamodb:GetItem", "Resource": "*" } ] } } } } } } ``` # AWS::DynamoDB::Table S3BucketSource The S3 bucket that is being imported from. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3Bucket](#cfn-dynamodb-table-s3bucketsource-s3bucket)" : String, "[S3BucketOwner](#cfn-dynamodb-table-s3bucketsource-s3bucketowner)" : String, "[S3KeyPrefix](#cfn-dynamodb-table-s3bucketsource-s3keyprefix)" : String } ``` ### YAML ``` [S3Bucket](#cfn-dynamodb-table-s3bucketsource-s3bucket): String [S3BucketOwner](#cfn-dynamodb-table-s3bucketsource-s3bucketowner): String [S3KeyPrefix](#cfn-dynamodb-table-s3bucketsource-s3keyprefix): String ``` ## Properties `S3Bucket` The S3 bucket that is being imported from. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9A-Z]+[\.\-\w]*[a-z0-9A-Z]+$` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `S3BucketOwner` The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional. *Required*: No *Type*: String *Pattern*: `[0-9]{12}` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `S3KeyPrefix` The key prefix shared by all S3 Objects that are being imported. *Required*: No *Type*: String *Maximum*: `1024` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DynamoDB::Table SSESpecification Represents the settings used to enable server-side encryption. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KMSMasterKeyId](#cfn-dynamodb-table-ssespecification-kmsmasterkeyid)" : String, "[SSEEnabled](#cfn-dynamodb-table-ssespecification-sseenabled)" : Boolean, "[SSEType](#cfn-dynamodb-table-ssespecification-ssetype)" : String } ``` ### YAML ``` [KMSMasterKeyId](#cfn-dynamodb-table-ssespecification-kmsmasterkeyid): String [SSEEnabled](#cfn-dynamodb-table-ssespecification-sseenabled): Boolean [SSEType](#cfn-dynamodb-table-ssespecification-ssetype): String ``` ## Properties `KMSMasterKeyId` 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*: 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) `SSEEnabled` Indicates whether server-side encryption is done 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 AWS owned key. *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` 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 *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DynamoDB::Table StreamSpecification Represents the DynamoDB Streams configuration for a table in DynamoDB. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ResourcePolicy](#cfn-dynamodb-table-streamspecification-resourcepolicy)" : ResourcePolicy, "[StreamViewType](#cfn-dynamodb-table-streamspecification-streamviewtype)" : String } ``` ### YAML ``` [ResourcePolicy](#cfn-dynamodb-table-streamspecification-resourcepolicy): ResourcePolicy [StreamViewType](#cfn-dynamodb-table-streamspecification-streamviewtype): String ``` ## Properties `ResourcePolicy` Creates or updates a resource-based policy document that contains the permissions for DynamoDB resources, such as a table's streams. 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. When you remove the `StreamSpecification` property from the template, DynamoDB disables the stream but retains any attached resource policy until the stream is deleted after 24 hours. When you modify the `StreamViewType` property, DynamoDB creates a new stream and retains the old stream's resource policy. The old stream and its resource policy are deleted after the 24-hour retention period. 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-table-resourcepolicy.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StreamViewType` 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::Table Tag 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 To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-dynamodb-table-tag-key)" : String, "[Value](#cfn-dynamodb-table-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-dynamodb-table-tag-key): String [Value](#cfn-dynamodb-table-tag-value): String ``` ## Properties `Key` 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` 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::Table TimeToLiveSpecification Represents the settings used to enable or disable Time to Live (TTL) for the specified table. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AttributeName](#cfn-dynamodb-table-timetolivespecification-attributename)" : String, "[Enabled](#cfn-dynamodb-table-timetolivespecification-enabled)" : Boolean } ``` ### YAML ``` [AttributeName](#cfn-dynamodb-table-timetolivespecification-attributename): String [Enabled](#cfn-dynamodb-table-timetolivespecification-enabled): Boolean ``` ## Properties `AttributeName` The name of the TTL attribute used to store the expiration time for items in the table. + The `AttributeName` property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name. *Required*: Conditional *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` 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::Table WarmThroughput 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 To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReadUnitsPerSecond](#cfn-dynamodb-table-warmthroughput-readunitspersecond)" : Integer, "[WriteUnitsPerSecond](#cfn-dynamodb-table-warmthroughput-writeunitspersecond)" : Integer } ``` ### YAML ``` [ReadUnitsPerSecond](#cfn-dynamodb-table-warmthroughput-readunitspersecond): Integer [WriteUnitsPerSecond](#cfn-dynamodb-table-warmthroughput-writeunitspersecond): Integer ``` ## Properties `ReadUnitsPerSecond` 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` 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)