You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DynamoDB::Types::CreateGlobalSecondaryIndexAction
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::CreateGlobalSecondaryIndexAction
- Defined in:
- (unknown)
Overview
When passing CreateGlobalSecondaryIndexAction as input to an Aws::Client method, you can use a vanilla Hash:
{
index_name: "IndexName", # required
key_schema: [ # required
{
attribute_name: "KeySchemaAttributeName", # required
key_type: "HASH", # required, accepts HASH, RANGE
},
],
projection: { # required
projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
non_key_attributes: ["NonKeyAttributeName"],
},
provisioned_throughput: {
read_capacity_units: 1, # required
write_capacity_units: 1, # required
},
}
Represents a new global secondary index to be added to an existing table.
Returned by:
Instance Attribute Summary collapse
-
#index_name ⇒ String
The name of the global secondary index to be created.
-
#key_schema ⇒ Array<Types::KeySchemaElement>
The key schema for the global secondary index.
-
#projection ⇒ Types::Projection
Represents attributes that are copied (projected) from the table into an index.
-
#provisioned_throughput ⇒ Types::ProvisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
Instance Attribute Details
#index_name ⇒ String
The name of the global secondary index to be created.
#key_schema ⇒ Array<Types::KeySchemaElement>
The key schema for the global secondary index.
#projection ⇒ Types::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.
#provisioned_throughput ⇒ Types::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.