Interface CfnGlobalTable.ReplicaSpecificationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGlobalTable.ReplicaSpecificationProperty.Jsii$Proxy
- Enclosing class:
CfnGlobalTable
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) .build()) .deletionProtectionEnabled(false) .globalSecondaryIndexes(List.of(ReplicaGlobalSecondaryIndexSpecificationProperty.builder() .indexName("indexName") // the properties below are optional .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder() .enabled(false) .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) .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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnGlobalTable.ReplicaSpecificationProperty
static final class
An implementation forCfnGlobalTable.ReplicaSpecificationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The settings used to enable or disable CloudWatch Contributor Insights for the specified replica.default Object
Determines if a replica is protected from deletion.default Object
Defines additional settings for the global secondary indexes of this replica.default Object
Defines the Kinesis Data Streams configuration for the specified replica.default Object
The settings used to enable point in time recovery.default Object
Sets read request settings for the replica table.default Object
Defines read capacity settings for the replica table.The region in which this replica exists.default Object
Represents the DynamoDB Streams configuration for a global table replica.default Object
A resource-based policy document that contains permissions to add to the specified replica of a DynamoDB global table.default Object
Allows you to specify a customer-managed key for the replica.default String
The table class of the specified table.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
The region in which this replica exists.- See Also:
-
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.
- See Also:
-
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 .
- See Also:
-
getGlobalSecondaryIndexes
Defines additional settings for the global secondary indexes of this replica.- See Also:
-
getKinesisStreamSpecification
Defines the Kinesis Data Streams configuration for the specified replica.- See Also:
-
getPointInTimeRecoverySpecification
The settings used to enable point in time recovery.When not specified, defaults to point in time recovery disabled for the replica.
- See Also:
-
getReadOnDemandThroughputSettings
Sets read request settings for the replica table.- See Also:
-
getReadProvisionedThroughputSettings
Defines read capacity settings for the replica table.- See Also:
-
getReplicaStreamSpecification
Represents the DynamoDB Streams configuration for a global table replica.- See Also:
-
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 .
- See Also:
-
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.
- See Also:
-
getTableClass
The table class of the specified table.Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
.- See Also:
-
getTags
An array of key-value pairs to apply to this replica.For more information, see Tag .
- See Also:
-
builder
-