Class: Aws::DynamoDB::Types::CreateGlobalSecondaryIndexAction
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::CreateGlobalSecondaryIndexAction
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-dynamodb/types.rb
Overview
When making an API call, you may pass CreateGlobalSecondaryIndexAction data as a 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.
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.
1590 1591 1592 1593 1594 1595 1596 |
# File 'lib/aws-sdk-dynamodb/types.rb', line 1590 class CreateGlobalSecondaryIndexAction < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput) include Aws::Structure end |
#key_schema ⇒ Array<Types::KeySchemaElement>
The key schema for the global secondary index.
1590 1591 1592 1593 1594 1595 1596 |
# File 'lib/aws-sdk-dynamodb/types.rb', line 1590 class CreateGlobalSecondaryIndexAction < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput) include Aws::Structure end |
#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.
1590 1591 1592 1593 1594 1595 1596 |
# File 'lib/aws-sdk-dynamodb/types.rb', line 1590 class CreateGlobalSecondaryIndexAction < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput) include Aws::Structure end |
#provisioned_throughput ⇒ Types::ProvisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see
- Limits][1
-
in the *Amazon DynamoDB Developer Guide*.
[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html
1590 1591 1592 1593 1594 1595 1596 |
# File 'lib/aws-sdk-dynamodb/types.rb', line 1590 class CreateGlobalSecondaryIndexAction < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput) include Aws::Structure end |