libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DynamoDB.Types.LocalSecondaryIndex

Description

 
Synopsis

Documentation

data LocalSecondaryIndex Source #

Represents the properties of a local secondary index.

See: newLocalSecondaryIndex smart constructor.

Constructors

LocalSecondaryIndex' 

Fields

  • indexName :: Text

    The name of the local secondary index. The name must be unique among all other indexes on this table.

  • keySchema :: NonEmpty KeySchemaElement

    The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

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

  • projection :: Projection

    Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Instances

Instances details
Eq LocalSecondaryIndex Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndex

Read LocalSecondaryIndex Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndex

Show LocalSecondaryIndex Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndex

Generic LocalSecondaryIndex Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndex

Associated Types

type Rep LocalSecondaryIndex :: Type -> Type #

NFData LocalSecondaryIndex Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndex

Methods

rnf :: LocalSecondaryIndex -> () #

Hashable LocalSecondaryIndex Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndex

ToJSON LocalSecondaryIndex Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndex

type Rep LocalSecondaryIndex Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndex

type Rep LocalSecondaryIndex = D1 ('MetaData "LocalSecondaryIndex" "Amazonka.DynamoDB.Types.LocalSecondaryIndex" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "LocalSecondaryIndex'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "keySchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty KeySchemaElement)) :*: S1 ('MetaSel ('Just "projection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Projection))))

newLocalSecondaryIndex Source #

Create a value of LocalSecondaryIndex 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:indexName:LocalSecondaryIndex', localSecondaryIndex_indexName - The name of the local secondary index. The name must be unique among all other indexes on this table.

$sel:keySchema:LocalSecondaryIndex', localSecondaryIndex_keySchema - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

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

$sel:projection:LocalSecondaryIndex', localSecondaryIndex_projection - Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

localSecondaryIndex_indexName :: Lens' LocalSecondaryIndex Text Source #

The name of the local secondary index. The name must be unique among all other indexes on this table.

localSecondaryIndex_keySchema :: Lens' LocalSecondaryIndex (NonEmpty KeySchemaElement) Source #

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

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

localSecondaryIndex_projection :: Lens' LocalSecondaryIndex Projection Source #

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.