addGlobalSecondaryIndex

addLocalSecondaryIndex

Adds a statement to the resource policy associated with this table.

A resource policy will be automatically created upon the first call to `addToResourcePolicy`.

Note that this does not work with imported tables.

addToResourcePolicy

Enable read capacity scaling for the given GSI.

autoScaleGlobalSecondaryIndexReadCapacity

Enable write capacity scaling for the given GSI.

autoScaleGlobalSecondaryIndexWriteCapacity

Enable read capacity scaling for this table.

autoScaleReadCapacity

Enable write capacity scaling for this table.

autoScaleWriteCapacity

schema

schemaV2

Table

Kinesis Data Stream approximate creation timestamp precision.

kinesisPrecisionTimestamp

Kinesis Data Stream to capture item-level changes for the table.

kinesisStream

Enforces a particular physical table name.

tableName

Specify how you are charged for read and write throughput and how you manage capacity.

billingMode

Whether CloudWatch contributor insights is enabled.

contributorInsightsEnabled

Whether CloudWatch contributor insights is enabled and what mode is selected.

contributorInsightsSpecification

Enables deletion protection for the table.

deletionProtection

Whether server-side encryption with an AWS managed customer master key is enabled.

This property cannot be set if `serverSideEncryption` is set.

> **NOTE**: if you set this to `CUSTOMER_MANAGED` and `encryptionKey` is not
> specified, the key that the Tablet generates for you will be created with
> default permissions. If you are using CDKv2, these permissions will be
> sufficient to enable the key for use with DynamoDB tables.  If you are
> using CDKv1, make sure the feature flag
> `@aws-cdk/aws-kms:defaultKeyPolicies` is set to `true` in your `cdk.json`.

encryption

External KMS key to use for table encryption.

This property can only be set if `encryption` is set to `TableEncryption.CUSTOMER_MANAGED`.

encryptionKey

The properties of data being imported from the S3 bucket source to the table.

importSource

The maximum read request units for the table.

Careful if you add Global Secondary Indexes, as
those will share the table's maximum on-demand throughput.

Can only be provided if billingMode is PAY_PER_REQUEST.

maxReadRequestUnits

The write request units for the table.

Careful if you add Global Secondary Indexes, as
those will share the table's maximum on-demand throughput.

Can only be provided if billingMode is PAY_PER_REQUEST.

maxWriteRequestUnits

Whether point-in-time recovery is enabled.

pointInTimeRecovery

Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.

pointInTimeRecoverySpecification

The read capacity for the table.

Careful if you add Global Secondary Indexes, as
those will share the table's provisioned throughput.

Can only be provided if billingMode is Provisioned.

readCapacity

The removal policy to apply to the DynamoDB Table.

removalPolicy

The removal policy to apply to the DynamoDB replica tables.

replicaRemovalPolicy

Regions where replica tables will be created.

replicationRegions

The timeout for a table replication operation in a single region.

replicationTimeout

resourcePolicy

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

stream

tableClass

timeToLiveAttribute

[WARNING: Use this flag with caution, misusing this flag may cause deleting existing replicas, refer to the detailed documentation for more information] Indicates whether CloudFormation stack waits for replication to finish.

If set to false, the CloudFormation resource will mark the resource as
created and replication will be completed asynchronously. This property is
ignored if replicationRegions property is not set.

WARNING:
DO NOT UNSET this property if adding/removing multiple replicationRegions
in one deployment, as CloudFormation only supports one region replication
at a time. CDK overcomes this limitation by waiting for replication to
finish before starting new replicationRegion.

If the custom resource which handles replication has a physical resource
ID with the format `region` instead of `tablename-region` (this would happen
if the custom resource hasn't received an event since v1.91.0), DO NOT SET
this property to false without making a change to the table name.
This will cause the existing replicas to be deleted.

waitForReplicationToFinish

Specify values to pre-warm you DynamoDB Table Warm Throughput feature is not available for Global Table replicas using the `Table` construct.

To enable Warm Throughput, use the `TableV2` construct instead.

warmThroughput

The write capacity for the table.

Careful if you add Global Secondary Indexes, as
those will share the table's provisioned throughput.

Can only be provided if billingMode is Provisioned.

writeCapacity

Partition key attribute definition.

If a single field forms the partition key, you can use this field.  Use the
`partitionKeys` field if the partition key is a multi-attribute key (consists of
multiple fields).

partitionKey

Sort key attribute definition.

If a single field forms the sort key, you can use this field.  Use the
`sortKeys` field if the sort key is a multi-attribute key (consists of multiple
fields).

sortKey

Add a global secondary index to the table.

Note: Global secondary indexes will be inherited by all replica tables.

Add a local secondary index to the table.

Note: Local secondary indexes will be inherited by all replica tables.

Add a replica table.

Note: Adding a replica table will allow you to use your table as a global table.

addReplica

Retrieve a replica table.

Note: Replica tables are not supported in a region agnostic stack.

replica

TableV2

The billing mode and capacity settings to apply to the table.

billing

When an item in the table is modified, StreamViewType determines what information is written to the stream.

dynamoStream

Global secondary indexes.

Note: You can provide a maximum of 20 global secondary indexes.

globalSecondaryIndexes

Controls whether table settings are synchronized across replicas.

When set to ALL, synchronizable settings (billing mode, throughput, TTL, streams view type, GSIs)
are automatically replicated across all replicas. When set to NONE, each replica manages its own
settings independently (billing mode must be PAY_PER_REQUEST).

Note: Some settings are always synchronized (key schema, LSIs) regardless of this setting,
and some are never synchronized (table class, SSE, deletion protection, PITR, tags, resource policy).

globalTableSettingsReplicationMode

Local secondary indexes.

Note: You can only provide a maximum of 5 local secondary indexes.

localSecondaryIndexes

Specifies the consistency mode for a new global table.

multiRegionConsistency

Replica tables to deploy with the primary table.

Note: Adding replica tables allows you to use your table as a global table. You
cannot specify a replica table in the region that the primary table will be deployed
to. Replica tables will only be supported if the stack deployment region is defined.

replicas

The warm throughput configuration for the table.

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.

Note: Witness region cannot be specified for a Multi-Region Eventual Consistency (MREC) Global Table.
Witness regions are only supported for Multi-Region Strong Consistency (MRSC) Global Tables.

witnessRegion

contributorInsights

Kinesis Data Stream to capture item level changes.

Resource policy to assign to DynamoDB Table.

Tags to be applied to the primary table (default replica table).

TableV2MultiAccountReplica

The server-side encryption configuration for the replica table.

Note: Each replica manages its own encryption independently. This is not synchronized
across replicas.

Whether or not to grant permissions for all indexes of the table.

Note: If false, permissions will only be granted to indexes when `globalIndexes` is specified.

grantIndexPermissions

The source table to replicate from.

[disable-awslint:prefer-ref-interface]

replicaSourceTable

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

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

CfnGlobalTable

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.

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

attributeDefinitions

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

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.

globalTableSourceArn

The list of witnesses of the MRSC global table.

Only one witness Region can be configured per MRSC global table.

globalTableWitnesses

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.

keySchema

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.

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.

readOnDemandThroughputSettings

readProvisionedThroughputSettings

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.

sseSpecification

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.

streamSpecification

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.

Specifies the time to live (TTL) settings for the table.

This setting will be applied to all replicas.

timeToLiveSpecification

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.

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

writeOnDemandThroughputSettings

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

writeProvisionedThroughputSettings

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.

CfnTable

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.

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

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

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

deletionProtectionEnabled

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.

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.

importSourceSpecification

The Kinesis Data Streams configuration for the specified table.

kinesisStreamSpecification

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.

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.

onDemandThroughput

The settings used to enable point in time recovery.

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.

provisionedThroughput

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.

Specifies the settings to enable server-side encryption.

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.

The table class of the new table.

Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS` .

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.

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

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.

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

Amazon DynamoDB

L2 Constructs3

Table

TableV2

TableV2MultiAccountReplica

L1 Constructs2

CfnGlobalTable

CfnTable

Get the Amazon DynamoDB Cheat Sheet

Quick Facts

Related Links