dynamodb/aws.sdk.kotlin.services.dynamodb.model/TableDescription/Builder

Builder

Properties

Contains information about the table archive.

var attributeDefinitions: List<AttributeDefinition>?

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

billingModeSummary

var billingModeSummary: BillingModeSummary?

Contains the details for the read/write capacity mode.

creationDateTime

var creationDateTime: Instant?

The date and time when the table was created, in UNIX epoch time format.

deletionProtectionEnabled

var deletionProtectionEnabled: Boolean?

Indicates whether deletion protection is enabled (true) or disabled (false) on the table.

globalSecondaryIndexes

var globalSecondaryIndexes: List<GlobalSecondaryIndexDescription>?

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

globalTableVersion

var globalTableVersion: String?

Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.

itemCount

var itemCount: Long?

The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

keySchema

var keySchema: List<KeySchemaElement>?

The primary key structure for the table. Each KeySchemaElement consists of:

latestStreamArn

var latestStreamArn: String?

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

latestStreamLabel

var latestStreamLabel: String?

A timestamp, in ISO 8601 format, for this stream.

localSecondaryIndexes

var localSecondaryIndexes: List<LocalSecondaryIndexDescription>?

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

multiRegionConsistency

var multiRegionConsistency: MultiRegionConsistency?

Indicates one of the following consistency modes for a global table:

onDemandThroughput

var onDemandThroughput: OnDemandThroughput?

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

provisionedThroughput

var provisionedThroughput: ProvisionedThroughputDescription?

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

replicas

var replicas: List<ReplicaDescription>?

Represents replicas of the table.

restoreSummary

var restoreSummary: RestoreSummary?

Contains details for the restore.

sseDescription

var sseDescription: SseDescription?

The description of the server-side encryption status on the specified table.

streamSpecification

var streamSpecification: StreamSpecification?

The current DynamoDB Streams configuration for the table.

tableArn

var tableArn: String?

The Amazon Resource Name (ARN) that uniquely identifies the table.

tableClassSummary

var tableClassSummary: TableClassSummary?

Contains details of the table class.

tableId

var tableId: String?

Unique identifier for the table for which the backup was created.

tableName

var tableName: String?

The name of the table.

tableSizeBytes

var tableSizeBytes: Long?

The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

tableStatus

var tableStatus: TableStatus?

The current state of the table:

warmThroughput

var warmThroughput: TableWarmThroughputDescription?

Describes the warm throughput value of the base table.