2.240.0

interface TableV2MultiAccountReplicaProps

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

Implements TableOptionsV2

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

NameTypeDescription
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.
encryption?TableEncryptionV2The server-side encryption configuration for the replica table.
globalTableSettingsReplicationMode?GlobalTableSettingsReplicationModeControls whether table settings are synchronized across replicas.
grantIndexPermissions?booleanWhether or not to grant permissions for all indexes of the table.
kinesisStream?IStreamKinesis Data Stream to capture item level changes.
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.
replicaSourceTable?ITableV2The source table to replicate from.
resourcePolicy?PolicyDocumentResource policy to assign to DynamoDB Table.
tableClass?TableClassThe table class.
tableName?stringEnforces a particular physical table name.
tags?CfnTag[]Tags to be applied to the primary table (default replica 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.

encryption?

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

The server-side encryption configuration for the replica table.

Note: Each replica manages its own encryption independently. This is not synchronized across replicas.

globalTableSettingsReplicationMode?

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

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

grantIndexPermissions?

Type: boolean (optional, default: false)

Whether or not to grant permissions for all indexes of the table.

Note: If false, permissions will only be granted to indexes when globalIndexes is specified.

kinesisStream?

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

Kinesis Data Stream to capture item level changes.

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.

replicaSourceTable?

Type: ITableV2 (optional, default: must be provided)

The source table to replicate from.

[disable-awslint:prefer-ref-interface]

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

tableClass?

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

The table class.

tableName?

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

Enforces a particular physical table name.

tags?

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

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

← PreviousNext →