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

Class: Aws::DynamoDBStreams::Types::KeySchemaElement

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

Overview

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 (partition key) would be represented by one KeySchemaElement. A composite primary key (partition key and sort key) would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

The name of a key attribute.

Returns:

  • (String)


301
302
303
304
305
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 301

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

#key_typeString

The attribute data, consisting of the data type and the attribute value itself.

Returns:

  • (String)


301
302
303
304
305
# File 'gems/aws-sdk-dynamodbstreams/lib/aws-sdk-dynamodbstreams/types.rb', line 301

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