AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DynamoDB::Table

CfnTable

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

Import

import { CfnTable } from 'aws-cdk-lib/aws-dynamodb';

Or use the module namespace:

import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
// dynamodb.CfnTable

Properties

Configuration passed to the constructor as CfnTableProps.

keySchemaRequired
IResolvable | IResolvable | KeySchemaProperty[]

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.

attributeDefinitionsOptional
IResolvable | IResolvable | AttributeDefinitionProperty[]

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.

billingModeOptional
string

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

contributorInsightsSpecificationOptional
IResolvable | ContributorInsightsSpecificationProperty

The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor.

deletionProtectionEnabledOptional
boolean | IResolvable

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 DynamoDB Developer Guide* .

globalSecondaryIndexesOptional
IResolvable | IResolvable | GlobalSecondaryIndexProperty[]

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.

importSourceSpecificationOptional
IResolvable | ImportSourceSpecificationProperty

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.

kinesisStreamSpecificationOptional
IResolvable | KinesisStreamSpecificationProperty

The Kinesis Data Streams configuration for the specified table.

localSecondaryIndexesOptional
IResolvable | IResolvable | LocalSecondaryIndexProperty[]

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.

onDemandThroughputOptional
IResolvable | OnDemandThroughputProperty

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.

pointInTimeRecoverySpecificationOptional
IResolvable | PointInTimeRecoverySpecificationProperty

The settings used to enable point in time recovery.

provisionedThroughputOptional
IResolvable | ProvisionedThroughputProperty

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.

resourcePolicyOptional
IResolvable | ResourcePolicyProperty

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.

sseSpecificationOptional
IResolvable | SSESpecificationProperty

Specifies the settings to enable server-side encryption.

streamSpecificationOptional
IResolvable | StreamSpecificationProperty

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.

tableClassOptional
string

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

tableNameOptional
string

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.

tagsOptional
CfnTag[]

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

timeToLiveSpecificationOptional
IResolvable | TimeToLiveSpecificationProperty

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.

warmThroughputOptional
IResolvable | WarmThroughputProperty

Represents the warm throughput (in read units per second and write units per second) for creating a table.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon DynamoDB Cheat Sheet

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

Download Free Infographic