You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DynamoDB::Types::GlobalSecondaryIndexUpdate

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Note:

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

Instance Attribute Details

#createTypes::CreateGlobalSecondaryIndexAction

The parameters required for creating a global secondary index on an existing table:

  • IndexName

  • KeySchema

  • AttributeDefinitions

  • Projection

  • ProvisionedThroughput



2856
2857
2858
2859
2860
2861
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2856

class GlobalSecondaryIndexUpdate < Struct.new(
  :update,
  :create,
  :delete)
  include Aws::Structure
end

#deleteTypes::DeleteGlobalSecondaryIndexAction

The name of an existing global secondary index to be removed.



2856
2857
2858
2859
2860
2861
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2856

class GlobalSecondaryIndexUpdate < Struct.new(
  :update,
  :create,
  :delete)
  include Aws::Structure
end

#updateTypes::UpdateGlobalSecondaryIndexAction

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.



2856
2857
2858
2859
2860
2861
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2856

class GlobalSecondaryIndexUpdate < Struct.new(
  :update,
  :create,
  :delete)
  include Aws::Structure
end