Interface ReplicaTableProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,TableOptionsV2
- All Known Implementing Classes:
ReplicaTableProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.92.0 (build db7f27d)",
date="2023-12-01T19:06:30.716Z")
@Stability(Stable)
public interface ReplicaTableProps
extends software.amazon.jsii.JsiiSerializable, TableOptionsV2
Properties used to configure a replica table.
Example:
import software.amazon.awscdk.*; App app = new App(); Stack stack = Stack.Builder.create(app, "Stack").env(Environment.builder().region("us-west-2").build()).build(); TableV2 globalTable = TableV2.Builder.create(stack, "GlobalTable") .partitionKey(Attribute.builder().name("pk").type(AttributeType.STRING).build()) .replicas(List.of(ReplicaTableProps.builder().region("us-east-1").build())) .build(); globalTable.addReplica(ReplicaTableProps.builder().region("us-east-2").deletionProtection(true).build());
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forReplicaTableProps
static final class
An implementation forReplicaTableProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic ReplicaTableProps.Builder
builder()
default Map<String,
ReplicaGlobalSecondaryIndexOptions> Options used to configure global secondary index properties.default Capacity
The read capacity.The region that the replica table will be created in.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.dynamodb.TableOptionsV2
getContributorInsights, getDeletionProtection, getKinesisStream, getPointInTimeRecovery, getTableClass, getTags
-
Method Details
-
getRegion
The region that the replica table will be created in. -
getGlobalSecondaryIndexOptions
@Stability(Stable) @Nullable default Map<String,ReplicaGlobalSecondaryIndexOptions> getGlobalSecondaryIndexOptions()Options used to configure global secondary index properties.Default: - inherited from the primary table
-
getReadCapacity
The read capacity.Note: This can only be configured if the primary table billing is provisioned.
Default: - inherited from the primary table
-
builder
- Returns:
- a
ReplicaTableProps.Builder
ofReplicaTableProps
-