interface ReplicaTableProps

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

Properties used to configure a replica 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 globalTable = new dynamodb.TableV2(stack, 'GlobalTable', {
  partitionKey: { name: 'pk', type: dynamodb.AttributeType.STRING },
  replicas: [{ region: 'us-east-1' }],
});

globalTable.addReplica({ region: 'us-east-2', deletionProtection: true });

Properties

Name	Type	Description
region	string	The region that the replica table will be created in.
contributorInsights?⚠️	boolean	Whether CloudWatch contributor insights is enabled.
contributorInsightsSpecification?	ContributorInsightsSpecification	Whether CloudWatch contributor insights is enabled and what mode is selected.
deletionProtection?	boolean	Whether deletion protection is enabled.
globalSecondaryIndexOptions?	{ [string]: ReplicaGlobalSecondaryIndexOptions }	Options used to configure global secondary index properties.
kinesisStream?	IStream	Kinesis Data Stream to capture item level changes.
maxReadRequestUnits?	number	The maximum read request units.
pointInTimeRecovery?⚠️	boolean	Whether point-in-time recovery is enabled.
pointInTimeRecoverySpecification?	PointInTimeRecoverySpecification	Whether point-in-time recovery is enabled and recoveryPeriodInDays is set.
readCapacity?	Capacity	The read capacity.
resourcePolicy?	PolicyDocument	Resource policy to assign to DynamoDB Table.
tableClass?	TableClass	The table class.
tags?	CfnTag[]	Tags to be applied to the primary table (default replica table).

---

region

Type: string

The region that the replica table will be created in.

---

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.

---

globalSecondaryIndexOptions?

Type: { [string]: ReplicaGlobalSecondaryIndexOptions } (optional, default: inherited from the primary table)

Options used to configure global secondary index properties.

---

kinesisStream?

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

Kinesis Data Stream to capture item level changes.

---

maxReadRequestUnits?

Type: number (optional, default: inherited from the primary table)

The maximum read request units.

Note: This can only be configured if the primary table billing is PAY_PER_REQUEST.

---

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.

---

readCapacity?

Type: Capacity (optional, default: inherited from the primary table)

The read capacity.

Note: This can only be configured if the primary table billing is provisioned.

---

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.

---

tags?

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

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