Class: Aws::DynamoDB::Types::GlobalSecondaryIndexUpdate
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::GlobalSecondaryIndexUpdate
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-dynamodb/types.rb
Overview
When making an API call, you may pass GlobalSecondaryIndexUpdate data as a 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: { # required
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 `
2451 2452 2453 2454 2455 2456 |
# File 'lib/aws-sdk-dynamodb/types.rb', line 2451 class GlobalSecondaryIndexUpdate < Struct.new( :update, :create, :delete) include Aws::Structure end |
#delete ⇒ Types::DeleteGlobalSecondaryIndexAction
The name of an existing global secondary index to be removed.
2451 2452 2453 2454 2455 2456 |
# File 'lib/aws-sdk-dynamodb/types.rb', line 2451 class GlobalSecondaryIndexUpdate < Struct.new( :update, :create, :delete) include Aws::Structure end |
#update ⇒ Types::UpdateGlobalSecondaryIndexAction
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
2451 2452 2453 2454 2455 2456 |
# File 'lib/aws-sdk-dynamodb/types.rb', line 2451 class GlobalSecondaryIndexUpdate < Struct.new( :update, :create, :delete) include Aws::Structure end |