Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DynamoDB.Types.KeySchemaElement

Description

Synopsis

data KeySchemaElement = KeySchemaElement' {
- attributeName :: Text
- keyType :: KeyType
}
newKeySchemaElement :: Text -> KeyType -> KeySchemaElement
keySchemaElement_attributeName :: Lens' KeySchemaElement Text
keySchemaElement_keyType :: Lens' KeySchemaElement KeyType

Documentation

data KeySchemaElement Source #

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: newKeySchemaElement smart constructor.

Constructors

KeySchemaElement'

Fields

attributeName :: Text
The name of a key attribute.
keyType :: KeyType
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.

Instances

Instances details

Eq KeySchemaElement Source #
Instance details Defined in Amazonka.DynamoDB.Types.KeySchemaElement Methods (==) :: KeySchemaElement -> KeySchemaElement -> Bool # (/=) :: KeySchemaElement -> KeySchemaElement -> Bool #
Read KeySchemaElement Source #
Instance details Defined in Amazonka.DynamoDB.Types.KeySchemaElement Methods readsPrec :: Int -> ReadS KeySchemaElement # readList :: ReadS [KeySchemaElement] # readPrec :: ReadPrec KeySchemaElement # readListPrec :: ReadPrec [KeySchemaElement] #
Show KeySchemaElement Source #
Instance details Defined in Amazonka.DynamoDB.Types.KeySchemaElement Methods showsPrec :: Int -> KeySchemaElement -> ShowS # show :: KeySchemaElement -> String # showList :: [KeySchemaElement] -> ShowS #
Generic KeySchemaElement Source #
Instance details Defined in Amazonka.DynamoDB.Types.KeySchemaElement Associated Types type Rep KeySchemaElement :: Type -> Type # Methods from :: KeySchemaElement -> Rep KeySchemaElement x # to :: Rep KeySchemaElement x -> KeySchemaElement #
NFData KeySchemaElement Source #
Instance details Defined in Amazonka.DynamoDB.Types.KeySchemaElement Methods rnf :: KeySchemaElement -> () #
Hashable KeySchemaElement Source #
Instance details Defined in Amazonka.DynamoDB.Types.KeySchemaElement Methods hashWithSalt :: Int -> KeySchemaElement -> Int # hash :: KeySchemaElement -> Int #
ToJSON KeySchemaElement Source #
Instance details Defined in Amazonka.DynamoDB.Types.KeySchemaElement Methods toJSON :: KeySchemaElement -> Value # toEncoding :: KeySchemaElement -> Encoding # toJSONList :: [KeySchemaElement] -> Value # toEncodingList :: [KeySchemaElement] -> Encoding #
FromJSON KeySchemaElement Source #
Instance details Defined in Amazonka.DynamoDB.Types.KeySchemaElement Methods parseJSON :: Value -> Parser KeySchemaElement # parseJSONList :: Value -> Parser [KeySchemaElement] #
type Rep KeySchemaElement Source #
Instance details Defined in Amazonka.DynamoDB.Types.KeySchemaElement type Rep KeySchemaElement = D1 ('MetaData "KeySchemaElement" "Amazonka.DynamoDB.Types.KeySchemaElement" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "KeySchemaElement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KeyType)))

newKeySchemaElement Source #

Arguments

:: Text	`$sel:attributeName:KeySchemaElement'`
-> KeyType	`$sel:keyType:KeySchemaElement'`
-> KeySchemaElement

Create a value of KeySchemaElement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributeName:KeySchemaElement', keySchemaElement_attributeName - The name of a key attribute.

$sel:keyType:KeySchemaElement', keySchemaElement_keyType - 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.

keySchemaElement_attributeName :: Lens' KeySchemaElement Text Source #

The name of a key attribute.

keySchemaElement_keyType :: Lens' KeySchemaElement KeyType Source #

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.