Aws::DynamoDB::Model::KeySchemaElement Class Reference

#include <KeySchemaElement.h>

Public Member Functions

AWS_DYNAMODB_API KeySchemaElement ()=default

 

AWS_DYNAMODB_API KeySchemaElement (Aws::Utils::Json::JsonView jsonValue)

 

AWS_DYNAMODB_API KeySchemaElement & operator= (Aws::Utils::Json::JsonView jsonValue)

 

AWS_DYNAMODB_API Aws::Utils::Json::JsonValue Jsonize () const

 

const Aws::String & GetAttributeName () const

 

bool AttributeNameHasBeenSet () const

 

template<typename AttributeNameT = Aws::String>

void SetAttributeName (AttributeNameT &&value)

 

template<typename AttributeNameT = Aws::String>

KeySchemaElement & WithAttributeName (AttributeNameT &&value)

 

KeyType GetKeyType () const

 

bool KeyTypeHasBeenSet () const

 

void SetKeyType (KeyType value)

 

KeySchemaElement & WithKeyType (KeyType value)

 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 37 of file KeySchemaElement.h.

Constructor & Destructor Documentation

KeySchemaElement() [1/2]

AWS_DYNAMODB_API Aws::DynamoDB::Model::KeySchemaElement::KeySchemaElement ( )

default

KeySchemaElement() [2/2]

AWS_DYNAMODB_API Aws::DynamoDB::Model::KeySchemaElement::KeySchemaElement ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

AttributeNameHasBeenSet()

bool Aws::DynamoDB::Model::KeySchemaElement::AttributeNameHasBeenSet ( ) const

inline

The name of a key attribute.

Definition at line 49 of file KeySchemaElement.h.

GetAttributeName()

const Aws::String & Aws::DynamoDB::Model::KeySchemaElement::GetAttributeName ( ) const

inline

The name of a key attribute.

Definition at line 48 of file KeySchemaElement.h.

GetKeyType()

KeyType Aws::DynamoDB::Model::KeySchemaElement::GetKeyType ( ) const

inline

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'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.

Definition at line 74 of file KeySchemaElement.h.

Jsonize()

AWS_DYNAMODB_API Aws::Utils::Json::JsonValue Aws::DynamoDB::Model::KeySchemaElement::Jsonize ( ) const

KeyTypeHasBeenSet()

bool Aws::DynamoDB::Model::KeySchemaElement::KeyTypeHasBeenSet ( ) const

inline

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'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.

Definition at line 75 of file KeySchemaElement.h.

operator=()

AWS_DYNAMODB_API KeySchemaElement & Aws::DynamoDB::Model::KeySchemaElement::operator= ( Aws::Utils::Json::JsonView  jsonValue)

SetAttributeName()

template<typename AttributeNameT = Aws::String>

void Aws::DynamoDB::Model::KeySchemaElement::SetAttributeName ( AttributeNameT &&  value)

inline

The name of a key attribute.

Definition at line 51 of file KeySchemaElement.h.

SetKeyType()

void Aws::DynamoDB::Model::KeySchemaElement::SetKeyType ( KeyType  value)

inline

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'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.

Definition at line 76 of file KeySchemaElement.h.

WithAttributeName()

template<typename AttributeNameT = Aws::String>

KeySchemaElement & Aws::DynamoDB::Model::KeySchemaElement::WithAttributeName ( AttributeNameT &&  value)

inline

The name of a key attribute.

Definition at line 56 of file KeySchemaElement.h.

WithKeyType()

KeySchemaElement & Aws::DynamoDB::Model::KeySchemaElement::WithKeyType ( KeyType  value)

inline

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'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.

Definition at line 80 of file KeySchemaElement.h.

---

The documentation for this class was generated from the following file:

• generated/src/aws-cpp-sdk-dynamodb/include/aws/dynamodb/model/KeySchemaElement.h