Class: Aws::DynamoDB::Types::GlobalSecondaryIndex

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

Overview

Represents the properties of a global secondary index.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#index_nameString

The name of the global secondary index. The name must be unique among all other indexes on this table.

Returns:

  • (String)


4097
4098
4099
4100
4101
4102
4103
4104
# File 'lib/aws-sdk-dynamodb/types.rb', line 4097

class GlobalSecondaryIndex < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#key_schemaArray<Types::KeySchemaElement>

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • ‘HASH` - partition key

  • ‘RANGE` - sort key

<note markdown=“1”> The partition key of an item is also known as its *hash attribute*. The term “hash attribute” derives from DynamoDB’s usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its *range attribute*. The

term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

</note>

Returns:



4097
4098
4099
4100
4101
4102
4103
4104
# File 'lib/aws-sdk-dynamodb/types.rb', line 4097

class GlobalSecondaryIndex < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#projectionTypes::Projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Returns:



4097
4098
4099
4100
4101
4102
4103
4104
# File 'lib/aws-sdk-dynamodb/types.rb', line 4097

class GlobalSecondaryIndex < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput)
  SENSITIVE = []
  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

Service, Account, and Table Quotas][1

in the *Amazon DynamoDB

Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html



4097
4098
4099
4100
4101
4102
4103
4104
# File 'lib/aws-sdk-dynamodb/types.rb', line 4097

class GlobalSecondaryIndex < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput)
  SENSITIVE = []
  include Aws::Structure
end