Package software.amazon.awscdk.services.dynamodb

Interface CfnGlobalTableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalTableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:28.252Z")
@Stability(Stable)
public interface CfnGlobalTableProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a 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;
 CfnGlobalTableProps cfnGlobalTableProps = CfnGlobalTableProps.builder()
         .attributeDefinitions(List.of(AttributeDefinitionProperty.builder()
                 .attributeName("attributeName")
                 .attributeType("attributeType")
                 .build()))
         .keySchema(List.of(KeySchemaProperty.builder()
                 .attributeName("attributeName")
                 .keyType("keyType")
                 .build()))
         .replicas(List.of(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())
                         .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())
                 .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()))
         // the properties below are optional
         .billingMode("billingMode")
         .globalSecondaryIndexes(List.of(GlobalSecondaryIndexProperty.builder()
                 .indexName("indexName")
                 .keySchema(List.of(KeySchemaProperty.builder()
                         .attributeName("attributeName")
                         .keyType("keyType")
                         .build()))
                 .projection(ProjectionProperty.builder()
                         .nonKeyAttributes(List.of("nonKeyAttributes"))
                         .projectionType("projectionType")
                         .build())
                 // the properties below are optional
                 .writeProvisionedThroughputSettings(WriteProvisionedThroughputSettingsProperty.builder()
                         .writeCapacityAutoScalingSettings(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())
                         .build())
                 .build()))
         .localSecondaryIndexes(List.of(LocalSecondaryIndexProperty.builder()
                 .indexName("indexName")
                 .keySchema(List.of(KeySchemaProperty.builder()
                         .attributeName("attributeName")
                         .keyType("keyType")
                         .build()))
                 .projection(ProjectionProperty.builder()
                         .nonKeyAttributes(List.of("nonKeyAttributes"))
                         .projectionType("projectionType")
                         .build())
                 .build()))
         .sseSpecification(SSESpecificationProperty.builder()
                 .sseEnabled(false)
                 // the properties below are optional
                 .sseType("sseType")
                 .build())
         .streamSpecification(StreamSpecificationProperty.builder()
                 .streamViewType("streamViewType")
                 .build())
         .tableName("tableName")
         .timeToLiveSpecification(TimeToLiveSpecificationProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .attributeName("attributeName")
                 .build())
         .writeProvisionedThroughputSettings(WriteProvisionedThroughputSettingsProperty.builder()
                 .writeCapacityAutoScalingSettings(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())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGlobalTableProps.Builder	builder()
Object	getAttributeDefinitions()	A list of attributes that describe the key schema for the global table and indexes.
default String	getBillingMode()	Specifies how you are charged for read and write throughput and how you manage capacity.
default Object	getGlobalSecondaryIndexes()	Global secondary indexes to be created on the global table.
Object	getKeySchema()	Specifies the attributes that make up the primary key for the table.
default Object	getLocalSecondaryIndexes()	Local secondary indexes to be created on the table.
Object	getReplicas()	Specifies the list of replicas for your global table.
default Object	getSseSpecification()	Specifies the settings to enable server-side encryption.
default Object	getStreamSpecification()	Specifies the streams settings on your global table.
default String	getTableName()	A name for the global table.
default Object	getTimeToLiveSpecification()	Specifies the time to live (TTL) settings for the table.
default Object	getWriteProvisionedThroughputSettings()	Specifies an auto scaling policy for write capacity.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributeDefinitions

@Stability(Stable)
@NotNull
Object getAttributeDefinitions()

A list of attributes that describe the key schema for the global table and indexes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-attributedefinitions

getKeySchema

@Stability(Stable)
@NotNull
Object getKeySchema()

Specifies the attributes that make up the primary key for the table.

The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-keyschema

getReplicas

@Stability(Stable)
@NotNull
Object getReplicas()

Specifies the list of replicas for your global table.

The list must contain at least one element, the region where the stack defining the global table is deployed. For example, if you define your table in a stack deployed to us-east-1, you must have an entry in Replicas with the region us-east-1. You cannot remove the replica in the stack region.

Adding a replica might take a few minutes for an empty table, or up to several hours for large tables. If you want to add or remove a replica, we recommend submitting an UpdateStack operation containing only that change.

If you add or delete a replica during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica.

You can create a new global table with as many replicas as needed. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-replicas

getBillingMode

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

Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:.

• PAY_PER_REQUEST
• PROVISIONED

All replicas in your global table will have the same billing mode. If you use PROVISIONED billing mode, you must provide an auto scaling configuration via the WriteProvisionedThroughputSettings property. The default value of this property is PROVISIONED .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-billingmode

getGlobalSecondaryIndexes

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

Global secondary indexes to be created on the global table.

You can create up to 20 global secondary indexes. Each replica in your global table will have the same global secondary index settings. You can only create or delete one global secondary index in a single stack operation.

Since the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active. If a stack operation rolls back, CloudFormation might not delete an index that has been added. In that case, you will need to delete the index manually.

See Also:

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

getLocalSecondaryIndexes

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

Local secondary indexes to be created on the table.

You can create up to five local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. Each replica in your global table will have the same local secondary index settings.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-localsecondaryindexes

getSseSpecification

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

Specifies the settings to enable server-side encryption.

These settings will be applied to all replicas. If you plan to use customer-managed KMS keys, you must provide a key for each replica using the ReplicaSpecification.ReplicaSSESpecification property.

See Also:

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

getStreamSpecification

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

Specifies the streams settings on your global table.

You must provide a value for this property if your global table contains more than one replica. You can only change the streams settings if your global table has only one replica.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-streamspecification

getTableName

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

A name for the global table.

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name. For more information, see Name type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-tablename

getTimeToLiveSpecification

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

Specifies the time to live (TTL) settings for the table.

This setting will be applied to all replicas.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-timetolivespecification

getWriteProvisionedThroughputSettings

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

Specifies an auto scaling policy for write capacity.

This policy will be applied to all replicas. This setting must be specified if BillingMode is set to PROVISIONED .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-globaltable.html#cfn-dynamodb-globaltable-writeprovisionedthroughputsettings

builder

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

Returns:

a CfnGlobalTableProps.Builder of CfnGlobalTableProps