AWS Fundamentals Logo
AWS Fundamentals
AWS::DynamoDB::Table

DynamoDB Table

The AWS::DynamoDB::Table resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*. You should be aware of the following behaviors when working with DDB tables: + CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limi...

Properties

20 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
KeySchema
Array<KeySchema> | object
Required
AttributeDefinitions
Array<AttributeDefinition>
BillingMode
string
ContributorInsightsSpecification
ContributorInsightsSpecification
DeletionProtectionEnabled
boolean
GlobalSecondaryIndexes
Array<GlobalSecondaryIndex>
ImportSourceSpecification
ImportSourceSpecification
Create-onlyWrite-only
KinesisStreamSpecification
KinesisStreamSpecification
LocalSecondaryIndexes
Array<LocalSecondaryIndex>
OnDemandThroughput
OnDemandThroughput
PointInTimeRecoverySpecification
PointInTimeRecoverySpecification
ProvisionedThroughput
ProvisionedThroughput
ResourcePolicy
ResourcePolicy
SSESpecification
SSESpecification
StreamSpecification
StreamSpecification
TableClass
string
TableName
string
Create-only
Tags
Array<Tag>
TimeToLiveSpecification
TimeToLiveSpecification
WarmThroughput
WarmThroughput

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
StreamArnstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DynamoDB::Table

Resources:
  MyResource:
    Type: AWS::DynamoDB::Table
    Properties:
      KeySchema: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

dynamodb:DescribeTabledynamodb:DescribeContinuousBackupsdynamodb:DescribeContributorInsightsdynamodb:DescribeKinesisStreamingDestinationdynamodb:ListTagsOfResourcedynamodb:GetResourcePolicydynamodb:DescribeTimeToLive

create

dynamodb:CreateTabledynamodb:DescribeImportdynamodb:DescribeTabledynamodb:DescribeTimeToLivedynamodb:UpdateTimeToLivedynamodb:UpdateContributorInsightsdynamodb:UpdateContinuousBackupsdynamodb:DescribeContinuousBackups

update

dynamodb:UpdateTabledynamodb:DescribeTabledynamodb:DescribeTimeToLivedynamodb:UpdateTimeToLivedynamodb:UpdateContinuousBackupsdynamodb:UpdateContributorInsightsdynamodb:UpdateKinesisStreamingDestinationdynamodb:DescribeContinuousBackups

list

dynamodb:ListTables

delete

dynamodb:DeleteTabledynamodb:DescribeTable

Get the DynamoDB Cheat Sheet

Everything you need to know about DynamoDB on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceDynamoDB
Properties22
Required1
TaggingSupported
Primary IDTableName

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

TableNameImportSourceSpecification

Related Resources

External Links