TablePropsV2 Struct
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' },
],
witnessRegion: 'us-east-2',
});
Properties
billingoptionalBillingbillingoptionalBillingbillingoptionalBillingBillingoptionalBillingBillingoptionalBilling= Billing.onDemand()#contributorInsightsoptionalbooleancontributor_insightsoptionalboolcontributorInsightsoptionalBooleanContributorInsightsoptionalboolContributorInsightsoptional*bool= falsedeprecated#contributorInsightsSpecificationoptionalContributorInsightsSpecificationcontributor_insights_specificationoptionalContributorInsightsSpecificationcontributorInsightsSpecificationoptionalContributorInsightsSpecificationContributorInsightsSpecificationoptionalContributorInsightsSpecificationContributorInsightsSpecificationoptionalContributorInsightsSpecification#Default: contributor insights is not enabled
deletionProtectionoptionalbooleandeletion_protectionoptionalbooldeletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptional*bool= false#dynamoStreamoptionalStreamViewTypedynamo_streamoptionalStreamViewTypedynamoStreamoptionalStreamViewTypeDynamoStreamoptionalStreamViewTypeDynamoStreamoptionalStreamViewType#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
encryptionoptionalTableEncryptionV2encryptionoptionalTableEncryptionV2encryptionoptionalTableEncryptionV2EncryptionoptionalTableEncryptionV2EncryptionoptionalTableEncryptionV2#Default: TableEncryptionV2.dynamoOwnedKey()
globalSecondaryIndexesoptionalGlobalSecondaryIndexPropsV2[]global_secondary_indexesoptionaltyping.List[GlobalSecondaryIndexPropsV2]globalSecondaryIndexesoptionalList<GlobalSecondaryIndexPropsV2>GlobalSecondaryIndexesoptionalGlobalSecondaryIndexPropsV2[]GlobalSecondaryIndexesoptional*[]GlobalSecondaryIndexPropsV2#Default: no global secondary indexes
Note: You can provide a maximum of 20 global secondary indexes.
globalTableSettingsReplicationModeoptionalGlobalTableSettingsReplicationModeglobal_table_settings_replication_modeoptionalGlobalTableSettingsReplicationModeglobalTableSettingsReplicationModeoptionalGlobalTableSettingsReplicationModeGlobalTableSettingsReplicationModeoptionalGlobalTableSettingsReplicationModeGlobalTableSettingsReplicationModeoptionalGlobalTableSettingsReplicationMode#Default: GlobalTableSettingsReplicationMode.NONE
notes
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).
kinesisStreamoptionalIStreamkinesis_streamoptionalIStreamkinesisStreamoptionalIStreamKinesisStreamoptionalIStreamKinesisStreamoptionalIStream#Default: no Kinesis Data Stream
localSecondaryIndexesoptionalLocalSecondaryIndexProps[]local_secondary_indexesoptionaltyping.List[LocalSecondaryIndexProps]localSecondaryIndexesoptionalList<LocalSecondaryIndexProps>LocalSecondaryIndexesoptionalLocalSecondaryIndexProps[]LocalSecondaryIndexesoptional*[]LocalSecondaryIndexProps#Default: no local secondary indexes
Note: You can only provide a maximum of 5 local secondary indexes.
multiRegionConsistencyoptionalMultiRegionConsistencymulti_region_consistencyoptionalMultiRegionConsistencymultiRegionConsistencyoptionalMultiRegionConsistencyMultiRegionConsistencyoptionalMultiRegionConsistencyMultiRegionConsistencyoptionalMultiRegionConsistency= MultiRegionConsistency.EVENTUAL#partitionKeyAttributepartition_keyAttributepartitionKeyAttributePartitionKeyAttributePartitionKeyAttributerequired#pointInTimeRecoveryoptionalbooleanpoint_in_time_recoveryoptionalboolpointInTimeRecoveryoptionalBooleanPointInTimeRecoveryoptionalboolPointInTimeRecoveryoptional*booldeprecated#Default: false - point in time recovery is not enabled.
pointInTimeRecoverySpecificationoptionalPointInTimeRecoverySpecificationpoint_in_time_recovery_specificationoptionalPointInTimeRecoverySpecificationpointInTimeRecoverySpecificationoptionalPointInTimeRecoverySpecificationPointInTimeRecoverySpecificationoptionalPointInTimeRecoverySpecificationPointInTimeRecoverySpecificationoptionalPointInTimeRecoverySpecification#Default: point in time recovery is not enabled.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.RETAIN#replicasoptionalReplicaTableProps[]replicasoptionaltyping.List[ReplicaTableProps]replicasoptionalList<ReplicaTableProps>ReplicasoptionalReplicaTableProps[]Replicasoptional*[]ReplicaTableProps#Default: no replica tables
notes
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.
resourcePolicyoptionalPolicyDocumentresource_policyoptionalPolicyDocumentresourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocument#Default: No resource policy statements are added to the created table.
sortKeyoptionalAttributesort_keyoptionalAttributesortKeyoptionalAttributeSortKeyoptionalAttributeSortKeyoptionalAttribute#Default: no sort key
streamResourcePolicyoptionalPolicyDocumentstream_resource_policyoptionalPolicyDocumentstreamResourcePolicyoptionalPolicyDocumentStreamResourcePolicyoptionalPolicyDocumentStreamResourcePolicyoptionalPolicyDocument#Default: No resource policy statements are added to the stream.
tableClassoptionalTableClasstable_classoptionalTableClasstableClassoptionalTableClassTableClassoptionalTableClassTableClassoptionalTableClass= TableClass.STANDARD#tableNameoptionalstringtable_nameoptionalstrtableNameoptionalStringTableNameoptionalstringTableNameoptional*string#Default: generated by CloudFormation
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#Default: no tags
timeToLiveAttributeoptionalstringtime_to_live_attributeoptionalstrtimeToLiveAttributeoptionalStringTimeToLiveAttributeoptionalstringTimeToLiveAttributeoptional*string#Default: TTL is disabled
warmThroughputoptionalWarmThroughputwarm_throughputoptionalWarmThroughputwarmThroughputoptionalWarmThroughputWarmThroughputoptionalWarmThroughputWarmThroughputoptionalWarmThroughput#Default: no warm throughput is configured
witnessRegionoptionalstringwitness_regionoptionalstrwitnessRegionoptionalStringWitnessRegionoptionalstringWitnessRegionoptional*string#Default: no witness region
notes
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.