TableV2MultiAccountReplicaProps Struct
Properties for creating a multi-account replica table.
Note: partitionKey, sortKey, and localSecondaryIndexes are not options because CloudFormation automatically inherits the key schema and LSIs from the source table via globalTableSourceArn.
Example
import * as cdk from 'aws-cdk-lib';
const app = new cdk.App();
// Source table in Account A
const sourceStack = new cdk.Stack(app, 'SourceStack', {
env: { region: 'us-east-2', account: '111111111111' },
});
const sourceTable = new dynamodb.TableV2(sourceStack, 'SourceTable', {
tableName: 'MyMultiAccountTable',
partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
globalTableSettingsReplicationMode: dynamodb.GlobalTableSettingsReplicationMode.ALL,
});
// Replica stack in Account B
const replicaStack = new cdk.Stack(app, 'ReplicaStack', {
env: { region: 'us-east-1', account: '222222222222' },
});
// Create replica - permissions are automatically configured
const replica = new dynamodb.TableV2MultiAccountReplica(replicaStack, 'ReplicaTable', {
tableName: 'MyMultiAccountTable',
replicaSourceTable: sourceTable,
globalTableSettingsReplicationMode: dynamodb.GlobalTableSettingsReplicationMode.ALL,
});
Properties
contributorInsightsoptionalbooleancontributor_insightsoptionalboolcontributorInsightsoptionalBooleanContributorInsightsoptionalboolContributorInsightsoptional*bool= falsedeprecated#contributorInsightsSpecificationoptionalContributorInsightsSpecificationcontributor_insights_specificationoptionalContributorInsightsSpecificationcontributorInsightsSpecificationoptionalContributorInsightsSpecificationContributorInsightsSpecificationoptionalContributorInsightsSpecificationContributorInsightsSpecificationoptionalContributorInsightsSpecification#Default: contributor insights is not enabled
deletionProtectionoptionalbooleandeletion_protectionoptionalbooldeletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptional*bool= false#encryptionoptionalTableEncryptionV2encryptionoptionalTableEncryptionV2encryptionoptionalTableEncryptionV2EncryptionoptionalTableEncryptionV2EncryptionoptionalTableEncryptionV2#Default: TableEncryptionV2.dynamoOwnedKey()
Note: Each replica manages its own encryption independently. This is not synchronized across replicas.
globalTableSettingsReplicationModeoptionalGlobalTableSettingsReplicationModeglobal_table_settings_replication_modeoptionalGlobalTableSettingsReplicationModeglobalTableSettingsReplicationModeoptionalGlobalTableSettingsReplicationModeGlobalTableSettingsReplicationModeoptionalGlobalTableSettingsReplicationModeGlobalTableSettingsReplicationModeoptionalGlobalTableSettingsReplicationMode#Default: GlobalTableSettingsReplicationMode.ALL
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).
grantIndexPermissionsoptionalbooleangrant_index_permissionsoptionalboolgrantIndexPermissionsoptionalBooleanGrantIndexPermissionsoptionalboolGrantIndexPermissionsoptional*bool= false#Note: If false, permissions will only be granted to indexes when globalIndexes is specified.
kinesisStreamoptionalIStreamkinesis_streamoptionalIStreamkinesisStreamoptionalIStreamKinesisStreamoptionalIStreamKinesisStreamoptionalIStream#Default: no Kinesis Data Stream
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#replicaSourceTableoptionalITableV2replica_source_tableoptionalITableV2replicaSourceTableoptionalITableV2ReplicaSourceTableoptionalITableV2ReplicaSourceTableoptionalITableV2#Default: must be provided
[disable-awslint:prefer-ref-interface]
resourcePolicyoptionalPolicyDocumentresource_policyoptionalPolicyDocumentresourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocument#Default: No resource policy statements are added to the created table.
streamResourcePolicyoptionalPolicyDocumentstream_resource_policyoptionalPolicyDocumentstreamResourcePolicyoptionalPolicyDocumentStreamResourcePolicyoptionalPolicyDocumentStreamResourcePolicyoptionalPolicyDocument#Default: No resource policy statements are added to the stream.
tableClassoptionalTableClasstable_classoptionalTableClasstableClassoptionalTableClassTableClassoptionalTableClassTableClassoptionalTableClass= TableClass.STANDARD#tableNameoptionalstringtable_nameoptionalstrtableNameoptionalStringTableNameoptionalstringTableNameoptional*string#Default: generated by CloudFormation