Package software.amazon.awscdk.cfnpropertymixins.services.dynamodb

Class CfnGlobalTableMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.dynamodb.CfnGlobalTableMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnGlobalTableMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnGlobalTableMixinProps

@Stability(Stable)
@Internal
public static final class CfnGlobalTableMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnGlobalTableMixinProps

An implementation for CfnGlobalTableMixinProps

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.dynamodb.CfnGlobalTableMixinProps

CfnGlobalTableMixinProps.Builder, CfnGlobalTableMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnGlobalTableMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnGlobalTableMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAttributeDefinitions()	A list of attributes that describe the key schema for the global table and indexes.
final String	getBillingMode()	Specifies how you are charged for read and write throughput and how you manage capacity.
final Object	getGlobalSecondaryIndexes()	Global secondary indexes to be created on the global table.
final String	getGlobalTableSourceArn()
final Object	getGlobalTableWitnesses()	The list of witnesses of the MRSC global table.
final Object	getKeySchema()	Specifies the attributes that make up the primary key for the table.
final Object	getLocalSecondaryIndexes()	Local secondary indexes to be created on the table.
final String	getMultiRegionConsistency()	Specifies the consistency mode for a new global table.
final Object	getReadOnDemandThroughputSettings()	Returns union: either IResolvable or CfnGlobalTablePropsMixin.ReadOnDemandThroughputSettingsProperty
final Object	getReadProvisionedThroughputSettings()	Returns union: either IResolvable or CfnGlobalTablePropsMixin.GlobalReadProvisionedThroughputSettingsProperty
final Object	getReplicas()	Specifies the list of replicas for your global table.
final Object	getSseSpecification()	Specifies the settings to enable server-side encryption.
final Object	getStreamSpecification()	Specifies the streams settings on your global table.
final String	getTableName()	A name for the global table.
final Object	getTimeToLiveSpecification()	Specifies the time to live (TTL) settings for the table.
final Object	getWarmThroughput()	Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.
final Object	getWriteOnDemandThroughputSettings()	Sets the write request settings for a global table or a global secondary index.
final Object	getWriteProvisionedThroughputSettings()	Specifies an auto scaling policy for write capacity.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnGlobalTableMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnGlobalTableMixinProps.Builder.

Method Details

getAttributeDefinitions

public final Object getAttributeDefinitions()

Description copied from interface: CfnGlobalTableMixinProps

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGlobalTablePropsMixin.AttributeDefinitionProperty>

Specified by:

getAttributeDefinitions in interface CfnGlobalTableMixinProps

See Also:

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

getBillingMode

public final String getBillingMode()

Description copied from interface: CfnGlobalTableMixinProps

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 .

Specified by:

getBillingMode in interface CfnGlobalTableMixinProps

See Also:

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

getGlobalSecondaryIndexes

public final Object getGlobalSecondaryIndexes()

Description copied from interface: CfnGlobalTableMixinProps

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGlobalTablePropsMixin.GlobalSecondaryIndexProperty>

Specified by:

getGlobalSecondaryIndexes in interface CfnGlobalTableMixinProps

See Also:

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

getGlobalTableSourceArn

public final String getGlobalTableSourceArn()

Specified by:

getGlobalTableSourceArn in interface CfnGlobalTableMixinProps

See Also:

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

getGlobalTableWitnesses

public final Object getGlobalTableWitnesses()

Description copied from interface: CfnGlobalTableMixinProps

The list of witnesses of the MRSC global table.

Only one witness Region can be configured per MRSC global table.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGlobalTablePropsMixin.GlobalTableWitnessProperty>

Specified by:

getGlobalTableWitnesses in interface CfnGlobalTableMixinProps

See Also:

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

getKeySchema

public final Object getKeySchema()

Description copied from interface: CfnGlobalTableMixinProps

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGlobalTablePropsMixin.KeySchemaProperty>

Specified by:

getKeySchema in interface CfnGlobalTableMixinProps

See Also:

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

getLocalSecondaryIndexes

public final Object getLocalSecondaryIndexes()

Description copied from interface: CfnGlobalTableMixinProps

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGlobalTablePropsMixin.LocalSecondaryIndexProperty>

Specified by:

getLocalSecondaryIndexes in interface CfnGlobalTableMixinProps

See Also:

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

getMultiRegionConsistency

public final String getMultiRegionConsistency()

Description copied from interface: CfnGlobalTableMixinProps

Specifies the consistency mode for a new global table.

You can specify one of the following consistency modes:

• EVENTUAL : Configures a new global table for multi-Region eventual consistency (MREC).
• STRONG : Configures a new global table for multi-Region strong consistency (MRSC).

If you don't specify this field, the global table consistency mode defaults to EVENTUAL . For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.

Specified by:

getMultiRegionConsistency in interface CfnGlobalTableMixinProps

See Also:

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

getReadOnDemandThroughputSettings

public final Object getReadOnDemandThroughputSettings()

Description copied from interface: CfnGlobalTableMixinProps

Returns union: either IResolvable or CfnGlobalTablePropsMixin.ReadOnDemandThroughputSettingsProperty

Specified by:

getReadOnDemandThroughputSettings in interface CfnGlobalTableMixinProps

See Also:

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

getReadProvisionedThroughputSettings

public final Object getReadProvisionedThroughputSettings()

Description copied from interface: CfnGlobalTableMixinProps

Returns union: either IResolvable or CfnGlobalTablePropsMixin.GlobalReadProvisionedThroughputSettingsProperty

Specified by:

getReadProvisionedThroughputSettings in interface CfnGlobalTableMixinProps

See Also:

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

getReplicas

public final Object getReplicas()

Description copied from interface: CfnGlobalTableMixinProps

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. For Multi-Region Strong Consistency (MRSC), you can add or remove up to 3 replicas, or 2 replicas plus a witness Region.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGlobalTablePropsMixin.ReplicaSpecificationProperty>

Specified by:

getReplicas in interface CfnGlobalTableMixinProps

See Also:

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

getSseSpecification

public final Object getSseSpecification()

Description copied from interface: CfnGlobalTableMixinProps

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.

Returns union: either IResolvable or CfnGlobalTablePropsMixin.SSESpecificationProperty

Specified by:

getSseSpecification in interface CfnGlobalTableMixinProps

See Also:

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

getStreamSpecification

public final Object getStreamSpecification()

Description copied from interface: CfnGlobalTableMixinProps

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. For Multi-Region Strong Consistency (MRSC), you do not need to provide a value for this property and can change the settings at any time.

Returns union: either IResolvable or CfnGlobalTablePropsMixin.StreamSpecificationProperty

Specified by:

getStreamSpecification in interface CfnGlobalTableMixinProps

See Also:

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

getTableName

public final String getTableName()

Description copied from interface: CfnGlobalTableMixinProps

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.

Specified by:

getTableName in interface CfnGlobalTableMixinProps

See Also:

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

getTimeToLiveSpecification

public final Object getTimeToLiveSpecification()

Description copied from interface: CfnGlobalTableMixinProps

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

This setting will be applied to all replicas.

Returns union: either IResolvable or CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty

Specified by:

getTimeToLiveSpecification in interface CfnGlobalTableMixinProps

See Also:

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

getWarmThroughput

public final Object getWarmThroughput()

Description copied from interface: CfnGlobalTableMixinProps

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.

Returns union: either IResolvable or CfnGlobalTablePropsMixin.WarmThroughputProperty

Specified by:

getWarmThroughput in interface CfnGlobalTableMixinProps

See Also:

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

getWriteOnDemandThroughputSettings

public final Object getWriteOnDemandThroughputSettings()

Description copied from interface: CfnGlobalTableMixinProps

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 .

Returns union: either IResolvable or CfnGlobalTablePropsMixin.WriteOnDemandThroughputSettingsProperty

Specified by:

getWriteOnDemandThroughputSettings in interface CfnGlobalTableMixinProps

See Also:

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

getWriteProvisionedThroughputSettings

public final Object getWriteProvisionedThroughputSettings()

Description copied from interface: CfnGlobalTableMixinProps

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 .

Returns union: either IResolvable or CfnGlobalTablePropsMixin.WriteProvisionedThroughputSettingsProperty

Specified by:

getWriteProvisionedThroughputSettings in interface CfnGlobalTableMixinProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object