interface TableProps

Language	Type name
.NET	Amazon.CDK.AWS.DynamoDB.TableProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#TableProps
Java	software.amazon.awscdk.services.dynamodb.TableProps
Python	aws_cdk.aws_dynamodb.TableProps
TypeScript (source)	aws-cdk-lib » aws_dynamodb » TableProps

Properties for a DynamoDB Table.

Example

import * as eventsources from 'aws-cdk-lib/aws-lambda-event-sources';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import { Key } from 'aws-cdk-lib/aws-kms';

declare const fn: lambda.Function;
const table = new dynamodb.Table(this, 'Table', {
  partitionKey: {
    name: 'id',
    type: dynamodb.AttributeType.STRING,
  },
  stream: dynamodb.StreamViewType.NEW_IMAGE,
});
// Your self managed KMS key
const myKey = Key.fromKeyArn(
  this,
  'SourceBucketEncryptionKey',
  'arn:aws:kms:us-east-1:123456789012:key/<key-id>',
);

fn.addEventSource(new eventsources.DynamoEventSource(table, {
  startingPosition: lambda.StartingPosition.LATEST,
  filters: [lambda.FilterCriteria.filter({ eventName: lambda.FilterRule.isEqual('INSERT') })],
  filterEncryption: myKey,
}));

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.
deletionProtection?	boolean	Enables deletion protection for the table.
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.
importSource?	ImportSourceSpecification	The properties of data being imported from the S3 bucket source to the table.
kinesisPrecisionTimestamp?	ApproximateCreationDateTimePrecision	Kinesis Data Stream approximate creation timestamp prescision.
kinesisStream?	IStream	Kinesis Data Stream to capture item-level changes for the table.
maxReadRequestUnits?	number	The maximum read request units for the table.
maxWriteRequestUnits?	number	The write request units 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.
resourcePolicy?	PolicyDocument	Resource policy to assign to table.
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	[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.
warmThroughput?	WarmThroughput	Specify values to pre-warm you DynamoDB Table Warm Throughput feature is not available for Global Table replicas using the Table construct.
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.

---

deletionProtection?

Type: boolean (optional, default: false)

Enables deletion protection for the table.

---

encryption?

Type: TableEncryption (optional, default: The table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.)

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. If encryption and this property are both undefined, then the table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.)

External KMS key to use for table encryption.

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

---

importSource?

Type: ImportSourceSpecification (optional, default: no data import from the S3 bucket)

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

---

kinesisPrecisionTimestamp?

Type: ApproximateCreationDateTimePrecision (optional, default: ApproximateCreationDateTimePrecision.MICROSECOND)

Kinesis Data Stream approximate creation timestamp prescision.

---

kinesisStream?

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

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

---

maxReadRequestUnits?

Type: number (optional, default: on-demand throughput is disabled)

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.

---

maxWriteRequestUnits?

Type: number (optional, default: on-demand throughput is disabled)

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.

---

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.

---

resourcePolicy?

Type: PolicyDocument (optional, default: No resource policy statement)

Resource policy to assign to table.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-resourcepolicy

---

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)

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

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas

---

warmThroughput?

Type: WarmThroughput (optional, default: warm throughput is not configured)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-warmthroughput

---

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.