Package software.amazon.awscdk.services.dynamodb

Class CfnGlobalTable.Builder

java.lang.Object

software.amazon.awscdk.services.dynamodb.CfnGlobalTable.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGlobalTable>

Enclosing class:

CfnGlobalTable

@Stability(Stable)
public static final class CfnGlobalTable.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGlobalTable>

A fluent builder for CfnGlobalTable.

Method Summary

Modifier and Type	Method	Description
CfnGlobalTable.Builder	attributeDefinitions(List<? extends Object> attributeDefinitions)	A list of attributes that describe the key schema for the global table and indexes.
CfnGlobalTable.Builder	attributeDefinitions(IResolvable attributeDefinitions)	A list of attributes that describe the key schema for the global table and indexes.
CfnGlobalTable.Builder	billingMode(String billingMode)	Specifies how you are charged for read and write throughput and how you manage capacity.
CfnGlobalTable	build()
static CfnGlobalTable.Builder	create(software.constructs.Construct scope, String id)
CfnGlobalTable.Builder	globalSecondaryIndexes(List<? extends Object> globalSecondaryIndexes)	Global secondary indexes to be created on the global table.
CfnGlobalTable.Builder	globalSecondaryIndexes(IResolvable globalSecondaryIndexes)	Global secondary indexes to be created on the global table.
CfnGlobalTable.Builder	keySchema(List<? extends Object> keySchema)	Specifies the attributes that make up the primary key for the table.
CfnGlobalTable.Builder	keySchema(IResolvable keySchema)	Specifies the attributes that make up the primary key for the table.
CfnGlobalTable.Builder	localSecondaryIndexes(List<? extends Object> localSecondaryIndexes)	Local secondary indexes to be created on the table.
CfnGlobalTable.Builder	localSecondaryIndexes(IResolvable localSecondaryIndexes)	Local secondary indexes to be created on the table.
CfnGlobalTable.Builder	replicas(List<? extends Object> replicas)	Specifies the list of replicas for your global table.
CfnGlobalTable.Builder	replicas(IResolvable replicas)	Specifies the list of replicas for your global table.
CfnGlobalTable.Builder	sseSpecification(IResolvable sseSpecification)	Specifies the settings to enable server-side encryption.
CfnGlobalTable.Builder	sseSpecification(CfnGlobalTable.SSESpecificationProperty sseSpecification)	Specifies the settings to enable server-side encryption.
CfnGlobalTable.Builder	streamSpecification(IResolvable streamSpecification)	Specifies the streams settings on your global table.
CfnGlobalTable.Builder	streamSpecification(CfnGlobalTable.StreamSpecificationProperty streamSpecification)	Specifies the streams settings on your global table.
CfnGlobalTable.Builder	tableName(String tableName)	A name for the global table.
CfnGlobalTable.Builder	timeToLiveSpecification(IResolvable timeToLiveSpecification)	Specifies the time to live (TTL) settings for the table.
CfnGlobalTable.Builder	timeToLiveSpecification(CfnGlobalTable.TimeToLiveSpecificationProperty timeToLiveSpecification)	Specifies the time to live (TTL) settings for the table.
CfnGlobalTable.Builder	warmThroughput(IResolvable warmThroughput)	Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.
CfnGlobalTable.Builder	warmThroughput(CfnGlobalTable.WarmThroughputProperty warmThroughput)	Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.
CfnGlobalTable.Builder	writeOnDemandThroughputSettings(IResolvable writeOnDemandThroughputSettings)	Sets the write request settings for a global table or a global secondary index.
CfnGlobalTable.Builder	writeOnDemandThroughputSettings(CfnGlobalTable.WriteOnDemandThroughputSettingsProperty writeOnDemandThroughputSettings)	Sets the write request settings for a global table or a global secondary index.
CfnGlobalTable.Builder	writeProvisionedThroughputSettings(IResolvable writeProvisionedThroughputSettings)	Specifies an auto scaling policy for write capacity.
CfnGlobalTable.Builder	writeProvisionedThroughputSettings(CfnGlobalTable.WriteProvisionedThroughputSettingsProperty writeProvisionedThroughputSettings)	Specifies an auto scaling policy for write capacity.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnGlobalTable.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnGlobalTable.Builder.

attributeDefinitions

@Stability(Stable)
public CfnGlobalTable.Builder attributeDefinitions(IResolvable attributeDefinitions)

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

Parameters:

attributeDefinitions - A list of attributes that describe the key schema for the global table and indexes. This parameter is required.

Returns:

this

See Also:

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

attributeDefinitions

@Stability(Stable)
public CfnGlobalTable.Builder attributeDefinitions(List<? extends Object> attributeDefinitions)

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

Parameters:

attributeDefinitions - A list of attributes that describe the key schema for the global table and indexes. This parameter is required.

Returns:

this

See Also:

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

keySchema

@Stability(Stable)
public CfnGlobalTable.Builder keySchema(IResolvable keySchema)

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.

Parameters:

keySchema - Specifies the attributes that make up the primary key for the table. This parameter is required.

Returns:

this

See Also:

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

keySchema

@Stability(Stable)
public CfnGlobalTable.Builder keySchema(List<? extends Object> keySchema)

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.

Parameters:

keySchema - Specifies the attributes that make up the primary key for the table. This parameter is required.

Returns:

this

See Also:

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

replicas

@Stability(Stable)
public CfnGlobalTable.Builder replicas(IResolvable replicas)

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.

Parameters:

replicas - Specifies the list of replicas for your global table. This parameter is required.

Returns:

this

See Also:

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

replicas

@Stability(Stable)
public CfnGlobalTable.Builder replicas(List<? extends Object> replicas)

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.

Parameters:

replicas - Specifies the list of replicas for your global table. This parameter is required.

Returns:

this

See Also:

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

billingMode

@Stability(Stable)
public CfnGlobalTable.Builder billingMode(String billingMode)

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 .

Parameters:

billingMode - Specifies how you are charged for read and write throughput and how you manage capacity. Valid values are:. This parameter is required.

Returns:

this

See Also:

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

globalSecondaryIndexes

@Stability(Stable)
public CfnGlobalTable.Builder globalSecondaryIndexes(IResolvable globalSecondaryIndexes)

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.

Parameters:

globalSecondaryIndexes - Global secondary indexes to be created on the global table. This parameter is required.

Returns:

this

See Also:

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

globalSecondaryIndexes

@Stability(Stable)
public CfnGlobalTable.Builder globalSecondaryIndexes(List<? extends Object> globalSecondaryIndexes)

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.

Parameters:

globalSecondaryIndexes - Global secondary indexes to be created on the global table. This parameter is required.

Returns:

this

See Also:

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

localSecondaryIndexes

@Stability(Stable)
public CfnGlobalTable.Builder localSecondaryIndexes(IResolvable localSecondaryIndexes)

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.

Parameters:

localSecondaryIndexes - Local secondary indexes to be created on the table. This parameter is required.

Returns:

this

See Also:

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

localSecondaryIndexes

@Stability(Stable)
public CfnGlobalTable.Builder localSecondaryIndexes(List<? extends Object> localSecondaryIndexes)

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.

Parameters:

localSecondaryIndexes - Local secondary indexes to be created on the table. This parameter is required.

Returns:

this

See Also:

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

sseSpecification

@Stability(Stable)
public CfnGlobalTable.Builder sseSpecification(IResolvable sseSpecification)

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.

Parameters:

sseSpecification - Specifies the settings to enable server-side encryption. This parameter is required.

Returns:

this

See Also:

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

sseSpecification

@Stability(Stable)
public CfnGlobalTable.Builder sseSpecification(CfnGlobalTable.SSESpecificationProperty sseSpecification)

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.

Parameters:

sseSpecification - Specifies the settings to enable server-side encryption. This parameter is required.

Returns:

this

See Also:

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

streamSpecification

@Stability(Stable)
public CfnGlobalTable.Builder streamSpecification(IResolvable streamSpecification)

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.

Parameters:

streamSpecification - Specifies the streams settings on your global table. This parameter is required.

Returns:

this

See Also:

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

streamSpecification

@Stability(Stable)
public CfnGlobalTable.Builder streamSpecification(CfnGlobalTable.StreamSpecificationProperty streamSpecification)

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.

Parameters:

streamSpecification - Specifies the streams settings on your global table. This parameter is required.

Returns:

this

See Also:

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

tableName

@Stability(Stable)
public CfnGlobalTable.Builder tableName(String tableName)

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.

Parameters:

tableName - A name for the global table. This parameter is required.

Returns:

this

See Also:

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

timeToLiveSpecification

@Stability(Stable)
public CfnGlobalTable.Builder timeToLiveSpecification(IResolvable timeToLiveSpecification)

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

This setting will be applied to all replicas.

Parameters:

timeToLiveSpecification - Specifies the time to live (TTL) settings for the table. This parameter is required.

Returns:

this

See Also:

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

timeToLiveSpecification

@Stability(Stable)
public CfnGlobalTable.Builder timeToLiveSpecification(CfnGlobalTable.TimeToLiveSpecificationProperty timeToLiveSpecification)

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

This setting will be applied to all replicas.

Parameters:

timeToLiveSpecification - Specifies the time to live (TTL) settings for the table. This parameter is required.

Returns:

this

See Also:

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

warmThroughput

@Stability(Stable)
public CfnGlobalTable.Builder warmThroughput(IResolvable warmThroughput)

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.

The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.

Parameters:

warmThroughput - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. This parameter is required.

Returns:

this

See Also:

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

warmThroughput

@Stability(Stable)
public CfnGlobalTable.Builder warmThroughput(CfnGlobalTable.WarmThroughputProperty warmThroughput)

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.

The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.

Parameters:

warmThroughput - Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. This parameter is required.

Returns:

this

See Also:

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

writeOnDemandThroughputSettings

@Stability(Stable)
public CfnGlobalTable.Builder writeOnDemandThroughputSettings(IResolvable writeOnDemandThroughputSettings)

Sets the write request settings for a global table or a global secondary index.

You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .

Parameters:

writeOnDemandThroughputSettings - Sets the write request settings for a global table or a global secondary index. This parameter is required.

Returns:

this

See Also:

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

writeOnDemandThroughputSettings

@Stability(Stable)
public CfnGlobalTable.Builder writeOnDemandThroughputSettings(CfnGlobalTable.WriteOnDemandThroughputSettingsProperty writeOnDemandThroughputSettings)

Sets the write request settings for a global table or a global secondary index.

You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .

Parameters:

writeOnDemandThroughputSettings - Sets the write request settings for a global table or a global secondary index. This parameter is required.

Returns:

this

See Also:

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

writeProvisionedThroughputSettings

@Stability(Stable)
public CfnGlobalTable.Builder writeProvisionedThroughputSettings(IResolvable writeProvisionedThroughputSettings)

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 .

Parameters:

writeProvisionedThroughputSettings - Specifies an auto scaling policy for write capacity. This parameter is required.

Returns:

this

See Also:

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

writeProvisionedThroughputSettings

@Stability(Stable)
public CfnGlobalTable.Builder writeProvisionedThroughputSettings(CfnGlobalTable.WriteProvisionedThroughputSettingsProperty writeProvisionedThroughputSettings)

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 .

Parameters:

writeProvisionedThroughputSettings - Specifies an auto scaling policy for write capacity. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnGlobalTable build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnGlobalTable>

Returns:

a newly built instance of CfnGlobalTable.