You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DynamoDB::Types::GlobalSecondaryIndexUpdate
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::GlobalSecondaryIndexUpdate
- Defined in:
- (unknown)
Overview
When passing GlobalSecondaryIndexUpdate as input to an Aws::Client method, you can use a vanilla Hash:
{
update: {
index_name: "IndexName", # required
provisioned_throughput: { # required
read_capacity_units: 1, # required
write_capacity_units: 1, # required
},
},
create: {
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
},
},
delete: {
index_name: "IndexName", # required
},
}
Represents one of the following:
-
A new global secondary index to be added to an existing table.
-
New provisioned throughput parameters for an existing global secondary index.
-
An existing global secondary index to be removed from an existing table.
Instance Attribute Summary collapse
-
#create ⇒ Types::CreateGlobalSecondaryIndexAction
The parameters required for creating a global secondary index on an existing table:.
-
#delete ⇒ Types::DeleteGlobalSecondaryIndexAction
The name of an existing global secondary index to be removed.
-
#update ⇒ Types::UpdateGlobalSecondaryIndexAction
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
Instance Attribute Details
#create ⇒ Types::CreateGlobalSecondaryIndexAction
The parameters required for creating a global secondary index on an existing table:
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
#delete ⇒ Types::DeleteGlobalSecondaryIndexAction
The name of an existing global secondary index to be removed.
#update ⇒ Types::UpdateGlobalSecondaryIndexAction
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.