TableGlobalSecondaryIndex class
Constructors
-
TableGlobalSecondaryIndex({Input<String?>? hashKey, Input<List<TableGlobalSecondaryIndexKeySchema>?>? keySchemas, required Input<String> name, Input<List<String>?>? nonKeyAttributes, Input<TableGlobalSecondaryIndexOnDemandThroughput?>? onDemandThroughput, required Input<String> projectionType, Input<String?>? rangeKey, Input<int?>? readCapacity, Input<TableGlobalSecondaryIndexWarmThroughput?>? warmThroughput, Input<int?>? writeCapacity})
-
Creates a new TableGlobalSecondaryIndex.
hashKey Name of the hash key in the index; must be defined as an attribute in the resource. Mutually exclusive with keySchema. Use keySchema instead.
keySchemas Configuration block(s) for the key schema. Mutually exclusive with hashKey and rangeKey. Required if hashKey is not specified. Supports multi-attribute keys for the Multi-Attribute Keys design pattern. See below.
name Name of the index.
nonKeyAttributes 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 Sets the maximum number of read and write units for the specified on-demand index. See below.
projectionType 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 hashKey and sortKey attributes, INCLUDE projects into the index all of the attributes that are defined in nonKeyAttributes in addition to the attributes that KEYS_ONLY project.
rangeKey Name of the range key; must be defined as an attribute in the resource. Mutually exclusive with keySchema. Use keySchema instead.
readCapacity Number of read units for this index. Must be set if billingMode is set to PROVISIONED.
warmThroughput Sets the number of warm read and write units for this index. See below.
writeCapacity Number of write units for this index. Must be set if billingMode is set to PROVISIONED.
const
-
TableGlobalSecondaryIndex.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
hashKey
→ Input<String?>?
-
Name of the hash key in the index; must be defined as an attribute in the resource. Mutually exclusive with
keySchema. Use keySchema instead.
final
-
keySchemas
→ Input<List<TableGlobalSecondaryIndexKeySchema>?>?
-
Configuration block(s) for the key schema. Mutually exclusive with
hashKey and rangeKey. Required if hashKey is not specified. Supports multi-attribute keys for the Multi-Attribute Keys design pattern. See below.
final
-
name
→ Input<String>
-
Name of the index.
final
-
nonKeyAttributes
→ Input<List<String>?>?
-
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.
final
-
onDemandThroughput
→ Input<TableGlobalSecondaryIndexOnDemandThroughput?>?
-
Sets the maximum number of read and write units for the specified on-demand index. See below.
final
-
projectionType
→ Input<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 hashKey and sortKey attributes, INCLUDE projects into the index all of the attributes that are defined in nonKeyAttributes in addition to the attributes that KEYS_ONLY project.
final
-
rangeKey
→ Input<String?>?
-
Name of the range key; must be defined as an attribute in the resource. Mutually exclusive with
keySchema. Use keySchema instead.
final
-
readCapacity
→ Input<int?>?
-
Number of read units for this index. Must be set if billingMode is set to PROVISIONED.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
warmThroughput
→ Input<TableGlobalSecondaryIndexWarmThroughput?>?
-
Sets the number of warm read and write units for this index. See below.
final
-
writeCapacity
→ Input<int?>?
-
Number of write units for this index. Must be set if billingMode is set to PROVISIONED.
final