interface TableProps

Language	Type name
.NET	`Amazon.CDK.AWS.DynamoDB.TableProps`
Java	`software.amazon.awscdk.services.dynamodb.TableProps`
Python	`aws_cdk.aws_dynamodb.TableProps`
TypeScript (source)	`@aws-cdk/aws-dynamodb` » `TableProps`

Properties for a DynamoDB Table.

Example

const globalTable = new dynamodb.Table(this, 'Table', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  replicationRegions: ['us-east-1', 'us-east-2', 'us-west-2'],
  billingMode: dynamodb.BillingMode.PROVISIONED,
});

globalTable.autoScaleWriteCapacity({
  minCapacity: 1,
  maxCapacity: 10,
}).scaleOnUtilization({ targetUtilizationPercent: 75 });

Properties

Name	Type	Description
partitionKey	`Attribute`	Partition key attribute definition.
billingMode?	`BillingMode`	Specify how you are charged for read and write throughput and how you manage capacity.
contributorInsightsEnabled?	`boolean`	Whether CloudWatch contributor insights is enabled.
encryption?	`TableEncryption`	Whether server-side encryption with an AWS managed customer master key is enabled.
encryptionKey?	`IKey`	External KMS key to use for table encryption.
kinesisStream?	`IStream`	Kinesis Data Stream to capture item-level changes for the table.
pointInTimeRecovery?	`boolean`	Whether point-in-time recovery is enabled.
readCapacity?	`number`	The read capacity for the table.
removalPolicy?	`RemovalPolicy`	The removal policy to apply to the DynamoDB Table.
replicationRegions?	`string[]`	Regions where replica tables will be created.
replicationTimeout?	`Duration`	The timeout for a table replication operation in a single region.
serverSideEncryption?⚠️	`boolean`	Whether server-side encryption with an AWS managed customer master key is enabled.
sortKey?	`Attribute`	Sort key attribute definition.
stream?	`StreamViewType`	When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.
tableClass?	`TableClass`	Specify the table class.
tableName?	`string`	Enforces a particular physical table name.
timeToLiveAttribute?	`string`	The name of TTL attribute.
waitForReplicationToFinish?	`boolean`	Indicates whether CloudFormation stack waits for replication to finish.
writeCapacity?	`number`	The write capacity for the table.

partitionKey

Type: Attribute

Partition key attribute definition.

billingMode?

Type: BillingMode (optional, default: PROVISIONED if replicationRegions is not specified, PAY_PER_REQUEST otherwise)

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

contributorInsightsEnabled?

Type: boolean (optional, default: false)

Whether CloudWatch contributor insights is enabled.

encryption?

Type: TableEncryption (optional, default: server-side encryption is enabled with an AWS owned customer master key)

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.

encryptionKey?

Type: IKey (optional, default: If encryption is set to TableEncryption.CUSTOMER_MANAGED and this property is undefined, a new KMS key will be created and associated with this table.)

External KMS key to use for table encryption.

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

kinesisStream?

Type: IStream (optional, default: no Kinesis Data Stream)

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

pointInTimeRecovery?

Type: boolean (optional, default: point-in-time recovery is disabled)

Whether point-in-time recovery is enabled.

readCapacity?

Type: number (optional, default: 5)

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.

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

The removal policy to apply to the DynamoDB Table.

replicationRegions?

Type: string[] (optional, default: no replica tables are created)

Regions where replica tables will be created.

replicationTimeout?

Type: Duration (optional, default: Duration.minutes(30))

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

serverSideEncryption?⚠️

⚠️ Deprecated: This property is deprecated. In order to obtain the same behavior as enabling this, set the encryption property to TableEncryption.AWS_MANAGED instead.

Type: boolean (optional, default: server-side encryption is enabled with an AWS owned customer master key)

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

This property cannot be set if encryption and/or encryptionKey is set.

sortKey?

Type: Attribute (optional, default: no sort key)

Sort key attribute definition.

stream?

Type: StreamViewType (optional, default: streams are disabled unless replicationRegions is specified)

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

tableClass?

Type: TableClass (optional, default: STANDARD)

Specify the table class.

tableName?

Type: string (optional, default: )

Enforces a particular physical table name.

timeToLiveAttribute?

Type: string (optional, default: TTL is disabled)

The name of TTL attribute.

waitForReplicationToFinish?

Type: boolean (optional, default: true)

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.

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.

writeCapacity?

Type: number (optional, default: 5)

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.