GlobalTableArgs

data class GlobalTableArgs(val attributeDefinitions: Output<List<GlobalTableAttributeDefinitionArgs>>? = null, val billingMode: Output<String>? = null, val globalSecondaryIndexes: Output<List<GlobalTableGlobalSecondaryIndexArgs>>? = null, val keySchema: Output<List<GlobalTableKeySchemaArgs>>? = null, val localSecondaryIndexes: Output<List<GlobalTableLocalSecondaryIndexArgs>>? = null, val replicas: Output<List<GlobalTableReplicaSpecificationArgs>>? = null, val sseSpecification: Output<GlobalTableSseSpecificationArgs>? = null, val streamSpecification: Output<GlobalTableStreamSpecificationArgs>? = null, val tableName: Output<String>? = null, val timeToLiveSpecification: Output<GlobalTableTimeToLiveSpecificationArgs>? = null, val writeOnDemandThroughputSettings: Output<GlobalTableWriteOnDemandThroughputSettingsArgs>? = null, val writeProvisionedThroughputSettings: Output<GlobalTableWriteProvisionedThroughputSettingsArgs>? = null) : ConvertibleToJava<GlobalTableArgs>

Version: None. Resource Type definition for AWS::DynamoDB::GlobalTable

Constructors

Link copied to clipboard
constructor(attributeDefinitions: Output<List<GlobalTableAttributeDefinitionArgs>>? = null, billingMode: Output<String>? = null, globalSecondaryIndexes: Output<List<GlobalTableGlobalSecondaryIndexArgs>>? = null, keySchema: Output<List<GlobalTableKeySchemaArgs>>? = null, localSecondaryIndexes: Output<List<GlobalTableLocalSecondaryIndexArgs>>? = null, replicas: Output<List<GlobalTableReplicaSpecificationArgs>>? = null, sseSpecification: Output<GlobalTableSseSpecificationArgs>? = null, streamSpecification: Output<GlobalTableStreamSpecificationArgs>? = null, tableName: Output<String>? = null, timeToLiveSpecification: Output<GlobalTableTimeToLiveSpecificationArgs>? = null, writeOnDemandThroughputSettings: Output<GlobalTableWriteOnDemandThroughputSettingsArgs>? = null, writeProvisionedThroughputSettings: Output<GlobalTableWriteProvisionedThroughputSettingsArgs>? = null)

Properties

Link copied to clipboard

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

Link copied to clipboard
val billingMode: Output<String>? = null

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val tableName: Output<String>? = null

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 .

Link copied to clipboard

Specifies the time to live (TTL) settings for the table. This setting will be applied to all replicas.

Link copied to clipboard

Sets the write request settings for a global table or a global secondary index. You must specify this setting if you set the BillingMode to PAY_PER_REQUEST .

Link copied to clipboard

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 .

Functions

Link copied to clipboard
open override fun toJava(): GlobalTableArgs