software.amazon.awscdk.services.dynamodb

Class CfnGlobalTable

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.dynamodb.CfnGlobalTable

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T09:30:46.630Z")
 @Stability(value=Stable)
public class CfnGlobalTable
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DynamoDB::GlobalTable`.

The AWS::DynamoDB::GlobalTable resource enables you to create and manage a Version 2019.11.21 global table. This resource cannot be used to create or manage a Version 2017.11.29 global table.

You cannot convert a resource of type AWS::DynamoDB::Table into a resource of type AWS::DynamoDB::GlobalTable by changing its type in your template. Doing so might result in the deletion of your DynamoDB table.

You can instead use the GlobalTable resource to create a new table in a single Region. This will be billed the same as a single Region table. If you later update the stack to add other Regions then Global Tables pricing will apply.

You should be aware of the following behaviors when working with DynamoDB global tables.

• The IAM Principal executing the stack operation must have the permissions listed below in all regions where you plan to have a global table replica. The IAM Principal's permissions should not have restrictions based on IP source address. Some global tables operations (for example, adding a replica) are asynchronous, and require that the IAM Principal is valid until they complete. You should not delete the Principal (user or IAM role) until CloudFormation has finished updating your stack.
• dynamodb:CreateTable
• dynamodb:UpdateTable
• dynamodb:DeleteTable
• dynamodb:DescribeContinuousBackups
• dynamodb:DescribeContributorInsights
• dynamodb:DescribeTable
• dynamodb:DescribeTableReplicaAutoScaling
• dynamodb:DescribeTimeToLive
• dynamodb:ListTables
• dynamodb:UpdateTimeToLive
• dynamodb:UpdateContributorInsights
• dynamodb:UpdateContinuousBackups
• dynamodb:ListTagsOfResource
• dynamodb:TagResource
• dynamodb:UntagResource
• dynamodb:BatchWriteItem
• dynamodb:CreateTableReplica
• dynamodb:DeleteItem
• dynamodb:DeleteTableReplica
• dynamodb:DisableKinesisStreamingDestination
• dynamodb:EnableKinesisStreamingDestination
• dynamodb:GetItem
• dynamodb:PutItem
• dynamodb:Query
• dynamodb:Scan
• dynamodb:UpdateItem
• dynamodb:DescribeTableReplicaAutoScaling
• dynamodb:UpdateTableReplicaAutoScaling
• iam:CreateServiceLinkedRole
• kms:CreateGrant
• kms:DescribeKey
• application-autoscaling:DeleteScalingPolicy
• application-autoscaling:DeleteScheduledAction
• application-autoscaling:DeregisterScalableTarget
• application-autoscaling:DescribeScalingPolicies
• application-autoscaling:DescribeScalableTargets
• application-autoscaling:PutScalingPolicy
• application-autoscaling:PutScheduledAction
• application-autoscaling:RegisterScalableTarget
• When using provisioned billing mode, CloudFormation will create an auto scaling policy on each of your replicas to control their write capacities. You must configure this policy using the WriteProvisionedThroughputSettings property. CloudFormation will ensure that all replicas have the same write capacity auto scaling property. You cannot directly specify a value for write capacity for a global table.
• If your table uses provisioned capacity, you must configure auto scaling directly in the AWS::DynamoDB::GlobalTable resource. You should not configure additional auto scaling policies on any of the table replicas or global secondary indexes, either via API or via AWS::ApplicationAutoScaling::ScalableTarget or AWS::ApplicationAutoScaling::ScalingPolicy . Doing so might result in unexpected behavior and is unsupported.
• In AWS CloudFormation , each global table is controlled by a single stack, in a single region, regardless of the number of replicas. When you deploy your template, CloudFormation will create/update all replicas as part of a single stack operation. You should not deploy the same AWS::DynamoDB::GlobalTable resource in multiple regions. Doing so will result in errors, and is unsupported. If you deploy your application template in multiple regions, you can use conditions to only create the resource in a single region. Alternatively, you can choose to define your AWS::DynamoDB::GlobalTable resources in a stack separate from your application stack, and make sure it is only deployed to a single region.

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.*;
 CfnGlobalTable cfnGlobalTable = CfnGlobalTable.Builder.create(this, "MyCfnGlobalTable")
         .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())
                 .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()))
         // 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnGlobalTable.AttributeDefinitionProperty Represents an attribute for describing the key schema for the table and indexes.
static class	CfnGlobalTable.Builder A fluent builder for CfnGlobalTable.
static interface	CfnGlobalTable.CapacityAutoScalingSettingsProperty Configures a scalable target and an autoscaling policy for a table or global secondary index's read or write capacity.
static interface	CfnGlobalTable.ContributorInsightsSpecificationProperty Configures contributor insights settings for a replica or one of its indexes.
static interface	CfnGlobalTable.GlobalSecondaryIndexProperty Allows you to specify a global secondary index for the global table.
static interface	CfnGlobalTable.KeySchemaProperty Represents *a single element* of a key schema.
static interface	CfnGlobalTable.LocalSecondaryIndexProperty Represents the properties of a local secondary index.
static interface	CfnGlobalTable.PointInTimeRecoverySpecificationProperty Represents the settings used to enable point in time recovery.
static interface	CfnGlobalTable.ProjectionProperty Represents attributes that are copied (projected) from the table into an index.
static interface	CfnGlobalTable.ReadProvisionedThroughputSettingsProperty Allows you to specify the read capacity settings for a replica table or a replica global secondary index when the `BillingMode` is set to `PROVISIONED` .
static interface	CfnGlobalTable.ReplicaGlobalSecondaryIndexSpecificationProperty Represents the properties of a global secondary index that can be set on a per-replica basis.
static interface	CfnGlobalTable.ReplicaSpecificationProperty Defines settings specific to a single replica of a global table.
static interface	CfnGlobalTable.ReplicaSSESpecificationProperty Allows you to specify a KMS key identifier to be used for server-side encryption.
static interface	CfnGlobalTable.SSESpecificationProperty Represents the settings used to enable server-side encryption.
static interface	CfnGlobalTable.StreamSpecificationProperty Represents the DynamoDB Streams configuration for a table in DynamoDB.
static interface	CfnGlobalTable.TargetTrackingScalingPolicyConfigurationProperty Defines a target tracking scaling policy.
static interface	CfnGlobalTable.TimeToLiveSpecificationProperty Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
static interface	CfnGlobalTable.WriteProvisionedThroughputSettingsProperty Specifies an auto scaling policy for write capacity.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGlobalTable(software.constructs.Construct scope, String id, CfnGlobalTableProps props) Create a new `AWS::DynamoDB::GlobalTable`.
protected	CfnGlobalTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGlobalTable(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the DynamoDB table, such as `arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable` .
Object	getAttributeDefinitions() A list of attributes that describe the key schema for the global table and indexes.
String	getAttrStreamArn() The ARN of the DynamoDB stream, such as `arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000` .
String	getAttrTableId() Unique identifier for the table, such as `a123b456-01ab-23cd-123a-111222aaabbb` .
String	getBillingMode() Specifies how you are charged for read and write throughput and how you manage capacity.
protected Map<String,Object>	getCfnProperties()
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.
Object	getLocalSecondaryIndexes() Local secondary indexes to be created on the table.
Object	getReplicas() Specifies the list of replicas for your global table.
Object	getSseSpecification() Specifies the settings to enable server-side encryption.
Object	getStreamSpecification() Specifies the streams settings on your global table.
String	getTableName() A name for the global table.
Object	getTimeToLiveSpecification() Specifies the time to live (TTL) settings for the table.
Object	getWriteProvisionedThroughputSettings() Specifies an auto scaling policy for write capacity.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAttributeDefinitions(IResolvable value) A list of attributes that describe the key schema for the global table and indexes.
void	setAttributeDefinitions(List<Object> value) A list of attributes that describe the key schema for the global table and indexes.
void	setBillingMode(String value) Specifies how you are charged for read and write throughput and how you manage capacity.
void	setGlobalSecondaryIndexes(IResolvable value) Global secondary indexes to be created on the global table.
void	setGlobalSecondaryIndexes(List<Object> value) Global secondary indexes to be created on the global table.
void	setKeySchema(IResolvable value) Specifies the attributes that make up the primary key for the table.
void	setKeySchema(List<Object> value) Specifies the attributes that make up the primary key for the table.
void	setLocalSecondaryIndexes(IResolvable value) Local secondary indexes to be created on the table.
void	setLocalSecondaryIndexes(List<Object> value) Local secondary indexes to be created on the table.
void	setReplicas(IResolvable value) Specifies the list of replicas for your global table.
void	setReplicas(List<Object> value) Specifies the list of replicas for your global table.
void	setSseSpecification(CfnGlobalTable.SSESpecificationProperty value) Specifies the settings to enable server-side encryption.
void	setSseSpecification(IResolvable value) Specifies the settings to enable server-side encryption.
void	setStreamSpecification(CfnGlobalTable.StreamSpecificationProperty value) Specifies the streams settings on your global table.
void	setStreamSpecification(IResolvable value) Specifies the streams settings on your global table.
void	setTableName(String value) A name for the global table.
void	setTimeToLiveSpecification(CfnGlobalTable.TimeToLiveSpecificationProperty value) Specifies the time to live (TTL) settings for the table.
void	setTimeToLiveSpecification(IResolvable value) Specifies the time to live (TTL) settings for the table.
void	setWriteProvisionedThroughputSettings(CfnGlobalTable.WriteProvisionedThroughputSettingsProperty value) Specifies an auto scaling policy for write capacity.
void	setWriteProvisionedThroughputSettings(IResolvable value) Specifies an auto scaling policy for write capacity.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGlobalTable

protected CfnGlobalTable(software.amazon.jsii.JsiiObjectRef objRef)

CfnGlobalTable

protected CfnGlobalTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGlobalTable

@Stability(value=Stable)
public CfnGlobalTable(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnGlobalTableProps props)

Create a new `AWS::DynamoDB::GlobalTable`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the DynamoDB table, such as `arn:aws:dynamodb:us-east-2:123456789012:table/myDynamoDBTable` .

The ARN returned is that of the replica in the region the stack is deployed to.

getAttrStreamArn

@Stability(value=Stable)
 @NotNull
public String getAttrStreamArn()

The ARN of the DynamoDB stream, such as `arn:aws:dynamodb:us-east-1:123456789012:table/testddbstack-myDynamoDBTable-012A1SL7SMP5Q/stream/2015-11-30T20:10:00.000` . The `StreamArn` returned is that of the replica in the region the stack is deployed to.

You must specify the StreamSpecification property to use this attribute.

getAttrTableId

@Stability(value=Stable)
 @NotNull
public String getAttrTableId()

Unique identifier for the table, such as `a123b456-01ab-23cd-123a-111222aaabbb` .

The TableId returned is that of the replica in the region the stack is deployed to.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAttributeDefinitions

@Stability(value=Stable)
 @NotNull
public Object getAttributeDefinitions()

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

setAttributeDefinitions

@Stability(value=Stable)
public void setAttributeDefinitions(@NotNull
                                                             IResolvable value)

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

setAttributeDefinitions

@Stability(value=Stable)
public void setAttributeDefinitions(@NotNull
                                                             List<Object> value)

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

getKeySchema

@Stability(value=Stable)
 @NotNull
public 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.

setKeySchema

@Stability(value=Stable)
public void setKeySchema(@NotNull
                                                  IResolvable value)

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.

setKeySchema

@Stability(value=Stable)
public void setKeySchema(@NotNull
                                                  List<Object> value)

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.

getReplicas

@Stability(value=Stable)
 @NotNull
public 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.

setReplicas

@Stability(value=Stable)
public void setReplicas(@NotNull
                                                 IResolvable value)

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.

setReplicas

@Stability(value=Stable)
public void setReplicas(@NotNull
                                                 List<Object> value)

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.

getBillingMode

@Stability(value=Stable)
 @Nullable
public 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 .

setBillingMode

@Stability(value=Stable)
public void setBillingMode(@Nullable
                                                    String value)

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 .

getGlobalSecondaryIndexes

@Stability(value=Stable)
 @Nullable
public 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.

setGlobalSecondaryIndexes

@Stability(value=Stable)
public void setGlobalSecondaryIndexes(@Nullable
                                                               IResolvable value)

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.

setGlobalSecondaryIndexes

@Stability(value=Stable)
public void setGlobalSecondaryIndexes(@Nullable
                                                               List<Object> value)

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.

getLocalSecondaryIndexes

@Stability(value=Stable)
 @Nullable
public 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.

setLocalSecondaryIndexes

@Stability(value=Stable)
public void setLocalSecondaryIndexes(@Nullable
                                                              IResolvable value)

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.

setLocalSecondaryIndexes

@Stability(value=Stable)
public void setLocalSecondaryIndexes(@Nullable
                                                              List<Object> value)

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.

getSseSpecification

@Stability(value=Stable)
 @Nullable
public 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.

setSseSpecification

@Stability(value=Stable)
public void setSseSpecification(@Nullable
                                                         CfnGlobalTable.SSESpecificationProperty value)

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.

setSseSpecification

@Stability(value=Stable)
public void setSseSpecification(@Nullable
                                                         IResolvable value)

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.

getStreamSpecification

@Stability(value=Stable)
 @Nullable
public 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.

setStreamSpecification

@Stability(value=Stable)
public void setStreamSpecification(@Nullable
                                                            CfnGlobalTable.StreamSpecificationProperty value)

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.

setStreamSpecification

@Stability(value=Stable)
public void setStreamSpecification(@Nullable
                                                            IResolvable value)

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.

getTableName

@Stability(value=Stable)
 @Nullable
public 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.

setTableName

@Stability(value=Stable)
public void setTableName(@Nullable
                                                  String value)

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.

getTimeToLiveSpecification

@Stability(value=Stable)
 @Nullable
public Object getTimeToLiveSpecification()

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

This setting will be applied to all replicas.

setTimeToLiveSpecification

@Stability(value=Stable)
public void setTimeToLiveSpecification(@Nullable
                                                                CfnGlobalTable.TimeToLiveSpecificationProperty value)

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

This setting will be applied to all replicas.

setTimeToLiveSpecification

@Stability(value=Stable)
public void setTimeToLiveSpecification(@Nullable
                                                                IResolvable value)

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

This setting will be applied to all replicas.

getWriteProvisionedThroughputSettings

@Stability(value=Stable)
 @Nullable
public 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 .

setWriteProvisionedThroughputSettings

@Stability(value=Stable)
public void setWriteProvisionedThroughputSettings(@Nullable
                                                                           CfnGlobalTable.WriteProvisionedThroughputSettingsProperty value)

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 .

setWriteProvisionedThroughputSettings

@Stability(value=Stable)
public void setWriteProvisionedThroughputSettings(@Nullable
                                                                           IResolvable value)

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 .