Class KeySchemaElement

Namespace

Amazon.DynamoDBv2.Model

Assembly

AWSSDK.DynamoDBv2.dll

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.

public class KeySchemaElement

Inheritance

object

KeySchemaElement

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

KeySchemaElement()

Empty constructor used to set properties independently even when a simple constructor is available

public KeySchemaElement()

KeySchemaElement(string, KeyType)

Instantiates KeySchemaElement with the parameterized properties

public KeySchemaElement(string attributeName, KeyType keyType)

Parameters

attributeName string

The name of a key attribute.

keyType KeyType

The role that this key attribute will assume:

• HASH

  - partition key

• RANGE

  - sort key

note

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.

Properties

AttributeName

Gets and sets the property AttributeName.

The name of a key attribute.

public string AttributeName { get; set; }

Property Value

string

KeyType

Gets and sets the property KeyType.

The role that this key attribute will assume:

• HASH

  - partition key

• RANGE

  - sort key

note

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.

public KeyType KeyType { get; set; }

Property Value

KeyType