Package software.amazon.awscdk.services.dynamodb

Interface ReplicaTableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TableOptionsV2

All Known Implementing Classes:

ReplicaTableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:00.046Z")
@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 Classes

Modifier and Type	Interface	Description
static final class	ReplicaTableProps.Builder	A builder for ReplicaTableProps
static final class	ReplicaTableProps.Jsii$Proxy	An implementation for ReplicaTableProps

Method Summary

Modifier and Type	Method	Description
static ReplicaTableProps.Builder	builder()
default Map<String,ReplicaGlobalSecondaryIndexOptions>	getGlobalSecondaryIndexOptions()	Options used to configure global secondary index properties.
default Number	getMaxReadRequestUnits()	The maxium read request units.
default Capacity	getReadCapacity()	The read capacity.
String	getRegion()	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, getResourcePolicy, getTableClass, getTags

Method Details

getRegion

@Stability(Stable)
@NotNull
String 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

getMaxReadRequestUnits

@Stability(Stable)
@Nullable
default Number getMaxReadRequestUnits()

The maxium read request units.

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

Default: - inherited from the primary table

getReadCapacity

@Stability(Stable)
@Nullable
default Capacity getReadCapacity()

The read capacity.

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

Default: - inherited from the primary table

builder

@Stability(Stable)
static ReplicaTableProps.Builder builder()

Returns:

a ReplicaTableProps.Builder of ReplicaTableProps