software.amazon.awscdk.services.dynamodb

Interface CfnGlobalTable.ReplicaSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalTable.ReplicaSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnGlobalTable

@Stability(value=Stable)
public static interface CfnGlobalTable.ReplicaSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

Defines settings specific to a single replica of a global table.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 ReplicaSpecificationProperty replicaSpecificationProperty = ReplicaSpecificationProperty.builder()
         .region("region")
         // the properties below are optional
         .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                 .enabled(false)
                 .build())
         .globalSecondaryIndexes(List.of(ReplicaGlobalSecondaryIndexSpecificationProperty.builder()
                 .indexName("indexName")
                 // the properties below are optional
                 .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                         .enabled(false)
                         .build())
                 .readProvisionedThroughputSettings(ReadProvisionedThroughputSettingsProperty.builder()
                         .readCapacityAutoScalingSettings(CapacityAutoScalingSettingsProperty.builder()
                                 .maxCapacity(123)
                                 .minCapacity(123)
                                 .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.builder()
                                         .targetValue(123)
                                         // the properties below are optional
                                         .disableScaleIn(false)
                                         .scaleInCooldown(123)
                                         .scaleOutCooldown(123)
                                         .build())
                                 // the properties below are optional
                                 .seedCapacity(123)
                                 .build())
                         .readCapacityUnits(123)
                         .build())
                 .build()))
         .pointInTimeRecoverySpecification(PointInTimeRecoverySpecificationProperty.builder()
                 .pointInTimeRecoveryEnabled(false)
                 .build())
         .readProvisionedThroughputSettings(ReadProvisionedThroughputSettingsProperty.builder()
                 .readCapacityAutoScalingSettings(CapacityAutoScalingSettingsProperty.builder()
                         .maxCapacity(123)
                         .minCapacity(123)
                         .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.builder()
                                 .targetValue(123)
                                 // the properties below are optional
                                 .disableScaleIn(false)
                                 .scaleInCooldown(123)
                                 .scaleOutCooldown(123)
                                 .build())
                         // the properties below are optional
                         .seedCapacity(123)
                         .build())
                 .readCapacityUnits(123)
                 .build())
         .sseSpecification(ReplicaSSESpecificationProperty.builder()
                 .kmsMasterKeyId("kmsMasterKeyId")
                 .build())
         .tableClass("tableClass")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnGlobalTable.ReplicaSpecificationProperty.Builder	builder()
default Object	getContributorInsightsSpecification() The settings used to enable or disable CloudWatch Contributor Insights for the specified replica.
default Object	getGlobalSecondaryIndexes() Defines additional settings for the global secondary indexes of this replica.
default Object	getPointInTimeRecoverySpecification() The settings used to enable point in time recovery.
default Object	getReadProvisionedThroughputSettings() Defines read capacity settings for the replica table.
String	getRegion() The region in which this replica exists.
default Object	getSseSpecification() Allows you to specify a customer-managed key for the replica.
default String	getTableClass() The table class of the specified table.
default List<CfnTag>	getTags() An array of key-value pairs to apply to this replica.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRegion

@Stability(value=Stable)
 @NotNull
String getRegion()

The region in which this replica exists.

getContributorInsightsSpecification

@Stability(value=Stable)
 @Nullable
default Object getContributorInsightsSpecification()

The settings used to enable or disable CloudWatch Contributor Insights for the specified replica.

When not specified, defaults to contributor insights disabled for the replica.

getGlobalSecondaryIndexes

@Stability(value=Stable)
 @Nullable
default Object getGlobalSecondaryIndexes()

Defines additional settings for the global secondary indexes of this replica.

getPointInTimeRecoverySpecification

@Stability(value=Stable)
 @Nullable
default Object getPointInTimeRecoverySpecification()

The settings used to enable point in time recovery.

When not specified, defaults to point in time recovery disabled for the replica.

getReadProvisionedThroughputSettings

@Stability(value=Stable)
 @Nullable
default Object getReadProvisionedThroughputSettings()

Defines read capacity settings for the replica table.

getSseSpecification

@Stability(value=Stable)
 @Nullable
default Object getSseSpecification()

Allows you to specify a customer-managed key for the replica.

When using customer-managed keys for server-side encryption, this property must have a value in all replicas.

getTableClass

@Stability(value=Stable)
 @Nullable
default String getTableClass()

The table class of the specified table.

Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this replica.

For more information, see Tag .

builder

@Stability(value=Stable)
static CfnGlobalTable.ReplicaSpecificationProperty.Builder builder()

Returns:

a CfnGlobalTable.ReplicaSpecificationProperty.Builder of CfnGlobalTable.ReplicaSpecificationProperty