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

Class: Aws::DynamoDB::Types::CreateGlobalSecondaryIndexAction

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 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: { # required
    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

Instance Attribute Details

#index_nameString

The name of the global secondary index to be created.

Returns:

  • (String)


994
995
996
997
998
999
1000
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 994

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput)
  include Aws::Structure
end

#key_schemaArray<Types::KeySchemaElement>

The key schema for the global secondary index.

Returns:



994
995
996
997
998
999
1000
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 994

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput)
  include Aws::Structure
end

#projectionTypes::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.

Returns:



994
995
996
997
998
999
1000
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 994

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput)
  include Aws::Structure
end

#provisioned_throughputTypes::ProvisionedThroughput

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.



994
995
996
997
998
999
1000
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 994

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput)
  include Aws::Structure
end