TableGlobalSecondaryIndex

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

Constructors

Link copied to clipboard
constructor(hashKey: String, name: String, nonKeyAttributes: List<String>? = null, projectionType: String, rangeKey: String? = null, readCapacity: Int? = null, writeCapacity: Int? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

Name of the index.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val rangeKey: String? = null

Name of the range key; must be defined

Link copied to clipboard
val readCapacity: Int? = null

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

Link copied to clipboard
val writeCapacity: Int? = null

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