Represents the properties of a global secondary index.
Contents NoteIn the following list, the required parameters are described first.
The name of the global secondary index. The name must be unique among all other indexes on this table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: [a-zA-Z0-9_.-]+
Required: Yes
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Type: Array of KeySchemaElement objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: Yes
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
Type: Projection object
Required: Yes
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits
, MaxWriteRequestUnits
, or both. You must use either OnDemandThroughput
or ProvisionedThroughput
based on your table's capacity mode.
Type: OnDemandThroughput object
Required: No
Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput
or ProvisionedThroughput
based on your table's capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
Type: ProvisionedThroughput object
Required: No
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond
, WriteUnitsPerSecond
, or both.
Type: WarmThroughput object
Required: No
For more information about using this API in one of the language-specific AWS SDKs, see the following:
Get
GlobalSecondaryIndexAutoScalingUpdate
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4