GetTableResult

data class GetTableResult(val arn: String? = null, val attributeDefinitions: List<TableAttributeDefinition>? = null, val billingMode: String? = null, val contributorInsightsSpecification: TableContributorInsightsSpecification? = null, val deletionProtectionEnabled: Boolean? = null, val globalSecondaryIndexes: List<TableGlobalSecondaryIndex>? = null, val keySchema: Either<List<TableKeySchema>, Any>? = null, val kinesisStreamSpecification: TableKinesisStreamSpecification? = null, val localSecondaryIndexes: List<TableLocalSecondaryIndex>? = null, val onDemandThroughput: TableOnDemandThroughput? = null, val pointInTimeRecoverySpecification: TablePointInTimeRecoverySpecification? = null, val provisionedThroughput: TableProvisionedThroughput? = null, val resourcePolicy: TableResourcePolicy? = null, val sseSpecification: TableSseSpecification? = null, val streamArn: String? = null, val streamSpecification: TableStreamSpecification? = null, val tableClass: String? = null, val tags: List<Tag>? = null, val timeToLiveSpecification: TableTimeToLiveSpecification? = null, val warmThroughput: TableWarmThroughput? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, attributeDefinitions: List<TableAttributeDefinition>? = null, billingMode: String? = null, contributorInsightsSpecification: TableContributorInsightsSpecification? = null, deletionProtectionEnabled: Boolean? = null, globalSecondaryIndexes: List<TableGlobalSecondaryIndex>? = null, keySchema: Either<List<TableKeySchema>, Any>? = null, kinesisStreamSpecification: TableKinesisStreamSpecification? = null, localSecondaryIndexes: List<TableLocalSecondaryIndex>? = null, onDemandThroughput: TableOnDemandThroughput? = null, pointInTimeRecoverySpecification: TablePointInTimeRecoverySpecification? = null, provisionedThroughput: TableProvisionedThroughput? = null, resourcePolicy: TableResourcePolicy? = null, sseSpecification: TableSseSpecification? = null, streamArn: String? = null, streamSpecification: TableStreamSpecification? = null, tableClass: String? = null, tags: List<Tag>? = null, timeToLiveSpecification: TableTimeToLiveSpecification? = null, warmThroughput: TableWarmThroughput? = 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 .

Link copied to clipboard

A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: Some interruptions. Replacement if you edit an existing AttributeDefinition.

Link copied to clipboard
val billingMode: String? = null

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

Link copied to clipboard

The settings used to enable or disable CloudWatch Contributor Insights for the specified table.

Link copied to clipboard

Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Developer Guide.

Link copied to clipboard

Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is `ACTIVE`. You can track its status by using the DynamoDB DescribeTable command. If you add or delete an index 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 index, you must manually delete the index. Updates are not supported. The following are exceptions:

Link copied to clipboard
val keySchema: Either<List<TableKeySchema>, Any>? = null

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

The Kinesis Data Streams configuration for the specified table.

Link copied to clipboard

Local secondary indexes to be created on the table. You can create up to 5 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.

Link copied to clipboard

Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.

Link copied to clipboard

The settings used to enable point in time recovery.

Link copied to clipboard

Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`. For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput. If you set `BillingMode` as `PROVISIONED`, you must specify this property. If you set `BillingMode` as `PAY_PER_REQUEST`, you cannot specify this property.

Link copied to clipboard

A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see Using resource-based policies for and Resource-based policy examples. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. For information about the considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.

Link copied to clipboard

Specifies the settings to enable server-side encryption.

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 .

Link copied to clipboard

The settings for the DDB table stream, which capture changes to items stored in the table.

Link copied to clipboard
val tableClass: String? = null

The table class of the new table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`.

Link copied to clipboard
val tags: List<Tag>? = null

An array of key-value pairs to apply to this resource. For more information, see Tag.

Link copied to clipboard

Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

Link copied to clipboard

Represents the warm throughput (in read units per second and write units per second) for creating a table.