2.248.0

interface TablePropsV2

LanguageType name
.NETAmazon.CDK.AWS.DynamoDB.TablePropsV2
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdynamodb#TablePropsV2
Javasoftware.amazon.awscdk.services.dynamodb.TablePropsV2
Pythonaws_cdk.aws_dynamodb.TablePropsV2
TypeScript (source)aws-cdk-lib » aws_dynamodb » TablePropsV2

Implements TableOptionsV2

Properties used to configure a DynamoDB table.

Example

import * as cdk from 'aws-cdk-lib';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'Stack', { env: { region: 'us-west-2' } });

const mrscTable = new dynamodb.TableV2(stack, 'MRSCTable', {
  partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
  multiRegionConsistency: dynamodb.MultiRegionConsistency.STRONG,
  replicas: [
    { region: 'us-east-1' },
    { region: 'us-east-2' },
  ],
});

Properties

NameTypeDescription
partitionKeyAttributePartition key attribute definition.
billing?BillingThe billing mode and capacity settings to apply to the table.
contributorInsights?⚠️booleanWhether CloudWatch contributor insights is enabled.
contributorInsightsSpecification?ContributorInsightsSpecificationWhether CloudWatch contributor insights is enabled and what mode is selected.
deletionProtection?booleanWhether deletion protection is enabled.
dynamoStream?StreamViewTypeWhen an item in the table is modified, StreamViewType determines what information is written to the stream.
encryption?TableEncryptionV2The server-side encryption.
globalSecondaryIndexes?GlobalSecondaryIndexPropsV2[]Global secondary indexes.
globalTableSettingsReplicationMode?GlobalTableSettingsReplicationModeControls whether table settings are synchronized across replicas.
kinesisStream?IStreamKinesis Data Stream to capture item level changes.
localSecondaryIndexes?LocalSecondaryIndexProps[]Local secondary indexes.
multiRegionConsistency?MultiRegionConsistencySpecifies the consistency mode for a new global table.
pointInTimeRecovery?⚠️booleanWhether point-in-time recovery is enabled.
pointInTimeRecoverySpecification?PointInTimeRecoverySpecificationWhether point-in-time recovery is enabled and recoveryPeriodInDays is set.
removalPolicy?RemovalPolicyThe removal policy applied to the table.
replicas?ReplicaTableProps[]Replica tables to deploy with the primary table.
resourcePolicy?PolicyDocumentResource policy to assign to DynamoDB Table.
sortKey?AttributeSort key attribute definition.
tableClass?TableClassThe table class.
tableName?stringThe name of the table.
tags?CfnTag[]Tags to be applied to the primary table (default replica table).
timeToLiveAttribute?stringThe name of the TTL attribute.
warmThroughput?WarmThroughputThe warm throughput configuration for the table.
witnessRegion?stringThe witness Region for the MRSC global table.

partitionKey

Type: Attribute

Partition key attribute definition.

billing?

Type: Billing (optional, default: Billing.onDemand())

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

contributorInsights?⚠️

⚠️ Deprecated: use contributorInsightsSpecification instead

Type: boolean (optional, default: false)

Whether CloudWatch contributor insights is enabled.

contributorInsightsSpecification?

Type: ContributorInsightsSpecification (optional, default: contributor insights is not enabled)

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

deletionProtection?

Type: boolean (optional, default: false)

Whether deletion protection is enabled.

dynamoStream?

Type: StreamViewType (optional, default: streams are disabled if replicas are not configured and this property is not specified. If this property is not specified when replicas are configured, then NEW_AND_OLD_IMAGES will be the StreamViewType for all replicas)

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

encryption?

Type: TableEncryptionV2 (optional, default: TableEncryptionV2.dynamoOwnedKey())

The server-side encryption.

globalSecondaryIndexes?

Type: GlobalSecondaryIndexPropsV2[] (optional, default: no global secondary indexes)

Global secondary indexes.

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

globalTableSettingsReplicationMode?

Type: GlobalTableSettingsReplicationMode (optional, default: GlobalTableSettingsReplicationMode.NONE)

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

kinesisStream?

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

Kinesis Data Stream to capture item level changes.

localSecondaryIndexes?

Type: LocalSecondaryIndexProps[] (optional, default: no local secondary indexes)

Local secondary indexes.

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

multiRegionConsistency?

Type: MultiRegionConsistency (optional, default: MultiRegionConsistency.EVENTUAL)

Specifies the consistency mode for a new global table.

pointInTimeRecovery?⚠️

⚠️ Deprecated: use pointInTimeRecoverySpecification instead

Type: boolean (optional, default: false - point in time recovery is not enabled.)

Whether point-in-time recovery is enabled.

pointInTimeRecoverySpecification?

Type: PointInTimeRecoverySpecification (optional, default: point in time recovery is not enabled.)

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

removalPolicy?

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

The removal policy applied to the table.

replicas?

Type: ReplicaTableProps[] (optional, default: no replica tables)

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.

resourcePolicy?

Type: PolicyDocument (optional, default: No resource policy statements are added to the created table.)

Resource policy to assign to DynamoDB Table.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-resourcepolicy

sortKey?

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

Sort key attribute definition.

tableClass?

Type: TableClass (optional, default: TableClass.STANDARD)

The table class.

tableName?

Type: string (optional, default: generated by CloudFormation)

The name of the table.

tags?

Type: CfnTag[] (optional, default: no tags)

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

timeToLiveAttribute?

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

The name of the TTL attribute.

warmThroughput?

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

The warm throughput configuration for the table.

witnessRegion?

Type: string (optional, default: no witness region)

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.

← PreviousNext →