pulumi-aws-kotlin/com.pulumi.aws.dynamodb.kotlin.outputs/TableGlobalSecondaryIndex

TableGlobalSecondaryIndex

data class TableGlobalSecondaryIndex(val hashKey: String, val name: String, val nonKeyAttributes: List<String>? = null, val onDemandThroughput: TableGlobalSecondaryIndexOnDemandThroughput? = null, val projectionType: String, val rangeKey: String? = null, val readCapacity: Int? = null, val writeCapacity: Int? = null)

Constructors

constructor(hashKey: String, name: String, nonKeyAttributes: List<String>? = null, onDemandThroughput: TableGlobalSecondaryIndexOnDemandThroughput? = null, projectionType: String, rangeKey: String? = null, readCapacity: Int? = null, writeCapacity: Int? = null)

Types

Companion

object Companion

Properties

hashKey

val hashKey: String

Name of the hash key in the index; must be defined as an attribute in the resource.

name

val name: String

Name of the index.

nonKeyAttributes

val nonKeyAttributes: List<String>? = null

Only required with INCLUDE as a projection type; a list of attributes to project into the index. These do not need to be defined as attributes on the table.

onDemandThroughput

val onDemandThroughput: TableGlobalSecondaryIndexOnDemandThroughput? = null

Sets the maximum number of read and write units for the specified on-demand table. See below.

projectionType

val projectionType: String

One of ALL, INCLUDE or KEYS_ONLY where ALL projects every attribute into the index, KEYS_ONLY projects into the index only the table and index hash_key and sort_key attributes , INCLUDE projects into the index all of the attributes that are defined in non_key_attributes in addition to the attributes that thatKEYS_ONLY project.

rangeKey

val rangeKey: String? = null

Name of the range key; must be defined

readCapacity

val readCapacity: Int? = null

Number of read units for this index. Must be set if billing_mode is set to PROVISIONED.

writeCapacity

val writeCapacity: Int? = null

Number of write units for this index. Must be set if billing_mode is set to PROVISIONED.