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

Class: Aws::DynamoDB::Types::KeySchemaElement

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 KeySchemaElement data as a hash:

{
  attribute_name: "KeySchemaAttributeName", # required
  key_type: "HASH", # required, accepts HASH, RANGE
}

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

The name of a key attribute.

Returns:

  • (String)


2536
2537
2538
2539
2540
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2536

class KeySchemaElement < Struct.new(
  :attribute_name,
  :key_type)
  include Aws::Structure
end

#key_typeString

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' 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.

Returns:

  • (String)


2536
2537
2538
2539
2540
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2536

class KeySchemaElement < Struct.new(
  :attribute_name,
  :key_type)
  include Aws::Structure
end