Package 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(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.*;
 Object policyDocument;
 ReplicaSpecificationProperty replicaSpecificationProperty = ReplicaSpecificationProperty.builder()
         .region("region")
         // the properties below are optional
         .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .mode("mode")
                 .build())
         .deletionProtectionEnabled(false)
         .globalSecondaryIndexes(List.of(ReplicaGlobalSecondaryIndexSpecificationProperty.builder()
                 .indexName("indexName")
                 // the properties below are optional
                 .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                         .enabled(false)
                         // the properties below are optional
                         .mode("mode")
                         .build())
                 .readOnDemandThroughputSettings(ReadOnDemandThroughputSettingsProperty.builder()
                         .maxReadRequestUnits(123)
                         .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()))
         .kinesisStreamSpecification(KinesisStreamSpecificationProperty.builder()
                 .streamArn("streamArn")
                 // the properties below are optional
                 .approximateCreationDateTimePrecision("approximateCreationDateTimePrecision")
                 .build())
         .pointInTimeRecoverySpecification(PointInTimeRecoverySpecificationProperty.builder()
                 .pointInTimeRecoveryEnabled(false)
                 .recoveryPeriodInDays(123)
                 .build())
         .readOnDemandThroughputSettings(ReadOnDemandThroughputSettingsProperty.builder()
                 .maxReadRequestUnits(123)
                 .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())
         .replicaStreamSpecification(ReplicaStreamSpecificationProperty.builder()
                 .resourcePolicy(ResourcePolicyProperty.builder()
                         .policyDocument(policyDocument)
                         .build())
                 .build())
         .resourcePolicy(ResourcePolicyProperty.builder()
                 .policyDocument(policyDocument)
                 .build())
         .sseSpecification(ReplicaSSESpecificationProperty.builder()
                 .kmsMasterKeyId("kmsMasterKeyId")
                 .build())
         .tableClass("tableClass")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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	getDeletionProtectionEnabled()	Determines if a replica is protected from deletion.
default Object	getGlobalSecondaryIndexes()	Defines additional settings for the global secondary indexes of this replica.
default Object	getKinesisStreamSpecification()	Defines the Kinesis Data Streams configuration for the specified replica.
default Object	getPointInTimeRecoverySpecification()	The settings used to enable point in time recovery.
default Object	getReadOnDemandThroughputSettings()	Sets read request settings for the replica table.
default Object	getReadProvisionedThroughputSettings()	Defines read capacity settings for the replica table.
String	getRegion()	The region in which this replica exists.
default Object	getReplicaStreamSpecification()	Represents the DynamoDB Streams configuration for a global table replica.
default Object	getResourcePolicy()	A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table.
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 Details

getRegion

@Stability(Stable)
@NotNull
String getRegion()

The region in which this replica exists.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-region

getContributorInsightsSpecification

@Stability(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.

Returns union: either IResolvable or CfnGlobalTable.ContributorInsightsSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-contributorinsightsspecification

getDeletionProtectionEnabled

@Stability(Stable)
@Nullable
default Object getDeletionProtectionEnabled()

Determines if a replica is protected from deletion.

When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Amazon DynamoDB Developer Guide .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-deletionprotectionenabled

getGlobalSecondaryIndexes

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

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-globalsecondaryindexes

getKinesisStreamSpecification

@Stability(Stable)
@Nullable
default Object getKinesisStreamSpecification()

Defines the Kinesis Data Streams configuration for the specified replica.

Returns union: either IResolvable or CfnGlobalTable.KinesisStreamSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-kinesisstreamspecification

getPointInTimeRecoverySpecification

@Stability(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.

Returns union: either IResolvable or CfnGlobalTable.PointInTimeRecoverySpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-pointintimerecoveryspecification

getReadOnDemandThroughputSettings

@Stability(Stable)
@Nullable
default Object getReadOnDemandThroughputSettings()

Sets read request settings for the replica table.

Returns union: either IResolvable or CfnGlobalTable.ReadOnDemandThroughputSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-readondemandthroughputsettings

getReadProvisionedThroughputSettings

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

Defines read capacity settings for the replica table.

Returns union: either IResolvable or CfnGlobalTable.ReadProvisionedThroughputSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-readprovisionedthroughputsettings

getReplicaStreamSpecification

@Stability(Stable)
@Nullable
default Object getReplicaStreamSpecification()

Represents the DynamoDB Streams configuration for a global table replica.

Returns union: either IResolvable or CfnGlobalTable.ReplicaStreamSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-replicastreamspecification

getResourcePolicy

@Stability(Stable)
@Nullable
default Object getResourcePolicy()

A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table.

Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.

In a CloudFormation template, you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to DynamoDB . For more information about resource-based policies, see Using resource-based policies for DynamoDB and Resource-based policy examples .

Returns union: either IResolvable or CfnGlobalTable.ResourcePolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-resourcepolicy

getSseSpecification

@Stability(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.

Returns union: either IResolvable or CfnGlobalTable.ReplicaSSESpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-ssespecification

getTableClass

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

The table class of the specified table.

Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-tableclass

getTags

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

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html#cfn-dynamodb-globaltable-replicaspecification-tags

builder

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

Returns:

a CfnGlobalTable.ReplicaSpecificationProperty.Builder of CfnGlobalTable.ReplicaSpecificationProperty