GetGlobalTableResult

data class GetGlobalTableResult(val arn: String? = null, val attributeDefinitions: List<GlobalTableAttributeDefinition>? = null, val billingMode: String? = null, val globalSecondaryIndexes: List<GlobalTableGlobalSecondaryIndex>? = null, val replicas: List<GlobalTableReplicaSpecification>? = null, val sseSpecification: GlobalTableSseSpecification? = null, val streamArn: String? = null, val streamSpecification: GlobalTableStreamSpecification? = null, val tableId: String? = null, val timeToLiveSpecification: GlobalTableTimeToLiveSpecification? = null, val writeOnDemandThroughputSettings: GlobalTableWriteOnDemandThroughputSettings? = null, val writeProvisionedThroughputSettings: GlobalTableWriteProvisionedThroughputSettings? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, attributeDefinitions: List<GlobalTableAttributeDefinition>? = null, billingMode: String? = null, globalSecondaryIndexes: List<GlobalTableGlobalSecondaryIndex>? = null, replicas: List<GlobalTableReplicaSpecification>? = null, sseSpecification: GlobalTableSseSpecification? = null, streamArn: String? = null, streamSpecification: GlobalTableStreamSpecification? = null, tableId: String? = null, timeToLiveSpecification: GlobalTableTimeToLiveSpecification? = null, writeOnDemandThroughputSettings: GlobalTableWriteOnDemandThroughputSettings? = null, writeProvisionedThroughputSettings: GlobalTableWriteProvisionedThroughputSettings? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

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.

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: 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 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
val streamArn: String? = null

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.

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 tableId: String? = null

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.

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 .