Amazonka.DynamoDB.Types.LocalSecondaryIndexInfo

Documentation

data LocalSecondaryIndexInfo

Represents the properties of a local secondary index for the table when the backup was created.

See: newLocalSecondaryIndexInfo smart constructor.

Constructors

LocalSecondaryIndexInfo'

Fields

• indexName :: Maybe Text

  Represents the name of the local secondary index.

• keySchema :: Maybe (NonEmpty KeySchemaElement)

  The complete key schema for a local secondary index, which consists 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 :: Maybe Projection

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

Instances

FromJSON LocalSecondaryIndexInfo

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexInfo

Methods

parseJSON :: Value -> Parser LocalSecondaryIndexInfo

parseJSONList :: Value -> Parser [LocalSecondaryIndexInfo]

Generic LocalSecondaryIndexInfo

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexInfo

Associated Types

type Rep LocalSecondaryIndexInfo :: Type -> Type

Methods

from :: LocalSecondaryIndexInfo -> Rep LocalSecondaryIndexInfo x

to :: Rep LocalSecondaryIndexInfo x -> LocalSecondaryIndexInfo

Read LocalSecondaryIndexInfo

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexInfo

Methods

readsPrec :: Int -> ReadS LocalSecondaryIndexInfo

readList :: ReadS [LocalSecondaryIndexInfo]

readPrec :: ReadPrec LocalSecondaryIndexInfo

readListPrec :: ReadPrec [LocalSecondaryIndexInfo]

Show LocalSecondaryIndexInfo

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexInfo

Methods

showsPrec :: Int -> LocalSecondaryIndexInfo -> ShowS

show :: LocalSecondaryIndexInfo -> String

showList :: [LocalSecondaryIndexInfo] -> ShowS

NFData LocalSecondaryIndexInfo

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexInfo

Methods

rnf :: LocalSecondaryIndexInfo -> ()

Eq LocalSecondaryIndexInfo

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexInfo

Methods

(==) :: LocalSecondaryIndexInfo -> LocalSecondaryIndexInfo -> Bool

(/=) :: LocalSecondaryIndexInfo -> LocalSecondaryIndexInfo -> Bool

Hashable LocalSecondaryIndexInfo

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexInfo

Methods

hashWithSalt :: Int -> LocalSecondaryIndexInfo -> Int

hash :: LocalSecondaryIndexInfo -> Int

type Rep LocalSecondaryIndexInfo

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexInfo

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

newLocalSecondaryIndexInfo :: LocalSecondaryIndexInfo

Create a value of LocalSecondaryIndexInfo 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:LocalSecondaryIndexInfo', localSecondaryIndexInfo_indexName - Represents the name of the local secondary index.

$sel:keySchema:LocalSecondaryIndexInfo', localSecondaryIndexInfo_keySchema - The complete key schema for a local secondary index, which consists 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:LocalSecondaryIndexInfo', localSecondaryIndexInfo_projection - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

localSecondaryIndexInfo_indexName :: Lens' LocalSecondaryIndexInfo (Maybe Text)

Represents the name of the local secondary index.

localSecondaryIndexInfo_keySchema :: Lens' LocalSecondaryIndexInfo (Maybe (NonEmpty KeySchemaElement))

The complete key schema for a local secondary index, which consists 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.

localSecondaryIndexInfo_projection :: Lens' LocalSecondaryIndexInfo (Maybe Projection)

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