Skip to content
v2.274.0

ReplicaTableProps Struct ​

Properties used to configure a replica table.

Example ​

ts
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 ​

contributorInsightsoptionalbooleancontributor_insightsoptionalboolcontributorInsightsoptionalBooleanContributorInsightsoptionalboolContributorInsightsoptional*bool= falsedeprecated#
use `contributorInsightsSpecification` instead
contributorInsightsSpecificationoptionalContributorInsightsSpecificationcontributor_insights_specificationoptionalContributorInsightsSpecificationcontributorInsightsSpecificationoptionalContributorInsightsSpecificationContributorInsightsSpecificationoptionalContributorInsightsSpecificationContributorInsightsSpecificationoptionalContributorInsightsSpecification#
Whether CloudWatch contributor insights is enabled and what mode is selected.

Default: contributor insights is not enabled

deletionProtectionoptionalbooleandeletion_protectionoptionalbooldeletionProtectionoptionalBooleanDeletionProtectionoptionalboolDeletionProtectionoptional*bool= false#
Whether deletion protection is enabled.
globalSecondaryIndexOptionsoptional{ [key: string]: ReplicaGlobalSecondaryIndexOptions }global_secondary_index_optionsoptionaltyping.Mapping[str, ReplicaGlobalSecondaryIndexOptions]globalSecondaryIndexOptionsoptionalMap<String, ReplicaGlobalSecondaryIndexOptions>GlobalSecondaryIndexOptionsoptionalIDictionary<string, ReplicaGlobalSecondaryIndexOptions>GlobalSecondaryIndexOptionsoptional*map[string]ReplicaGlobalSecondaryIndexOptions#
Options used to configure global secondary index properties.

Default: inherited from the primary table

kinesisStreamoptionalIStreamkinesis_streamoptionalIStreamkinesisStreamoptionalIStreamKinesisStreamoptionalIStreamKinesisStreamoptionalIStream#
Kinesis Data Stream to capture item level changes.

Default: no Kinesis Data Stream

maxReadRequestUnitsoptionalnumbermax_read_request_unitsoptionalint | floatmaxReadRequestUnitsoptionalNumberMaxReadRequestUnitsoptionaldoubleMaxReadRequestUnitsoptional*float64#
The maximum read request units.

Default: inherited from the primary table

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

pointInTimeRecoveryoptionalbooleanpoint_in_time_recoveryoptionalboolpointInTimeRecoveryoptionalBooleanPointInTimeRecoveryoptionalboolPointInTimeRecoveryoptional*booldeprecated#
use `pointInTimeRecoverySpecification` instead

Default: false - point in time recovery is not enabled.

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

Default: point in time recovery is not enabled.

readCapacityoptionalCapacityread_capacityoptionalCapacityreadCapacityoptionalCapacityReadCapacityoptionalCapacityReadCapacityoptionalCapacity#
The read capacity.

Default: inherited from the primary table

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

regionstringregionstrregionStringRegionstringRegion*stringrequired#
The region that the replica table will be created in.
resourcePolicyoptionalPolicyDocumentresource_policyoptionalPolicyDocumentresourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocumentResourcePolicyoptionalPolicyDocument#
Resource policy to assign to DynamoDB Table.

Default: No resource policy statements are added to the created table.

streamResourcePolicyoptionalPolicyDocumentstream_resource_policyoptionalPolicyDocumentstreamResourcePolicyoptionalPolicyDocumentStreamResourcePolicyoptionalPolicyDocumentStreamResourcePolicyoptionalPolicyDocument#
Resource policy to assign to DynamoDB Stream.

Default: No resource policy statements are added to the stream.

tableClassoptionalTableClasstable_classoptionalTableClasstableClassoptionalTableClassTableClassoptionalTableClassTableClassoptionalTableClass= TableClass.STANDARD#
The table class.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Tags to be applied to the primary table (default replica table).

Default: no tags