Represents a new global secondary index to be added to an existing table.
Contents
Note
In the following list, the required parameters are described first.
- IndexName
-
The name of the global secondary index to be created.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+Required: Yes
- KeySchema
-
The key schema for the global secondary index.
Type: Array of KeySchemaElement objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: Yes
- Projection
-
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
Type: Projection object
Required: Yes
- OnDemandThroughput
-
The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify
MaxReadRequestUnits,MaxWriteRequestUnits, or both. You must use eitherOnDemand ThroughputorProvisionedThroughputbased on your table's capacity mode.Type: OnDemandThroughput object
Required: No
- ProvisionedThroughput
-
Represents the provisioned throughput settings for the specified global secondary index.
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
- WarmThroughput
-
Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.
Type: WarmThroughput object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
