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

Description

 
Synopsis

Documentation

data GlobalSecondaryIndexInfo Source #

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

See: newGlobalSecondaryIndexInfo smart constructor.

Constructors

GlobalSecondaryIndexInfo' 

Fields

  • provisionedThroughput :: Maybe ProvisionedThroughput

    Represents the provisioned throughput settings for the specified global secondary index.

  • keySchema :: Maybe (NonEmpty KeySchemaElement)

    The complete key schema for a global 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.

  • indexName :: Maybe Text

    The name of the global secondary index.

Instances

Instances details
Eq GlobalSecondaryIndexInfo Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndexInfo

Read GlobalSecondaryIndexInfo Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndexInfo

Show GlobalSecondaryIndexInfo Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndexInfo

Generic GlobalSecondaryIndexInfo Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndexInfo

Associated Types

type Rep GlobalSecondaryIndexInfo :: Type -> Type #

NFData GlobalSecondaryIndexInfo Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndexInfo

Hashable GlobalSecondaryIndexInfo Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndexInfo

FromJSON GlobalSecondaryIndexInfo Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndexInfo

type Rep GlobalSecondaryIndexInfo Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndexInfo

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

newGlobalSecondaryIndexInfo :: GlobalSecondaryIndexInfo Source #

Create a value of GlobalSecondaryIndexInfo 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:provisionedThroughput:GlobalSecondaryIndexInfo', globalSecondaryIndexInfo_provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index.

$sel:keySchema:GlobalSecondaryIndexInfo', globalSecondaryIndexInfo_keySchema - The complete key schema for a global 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:GlobalSecondaryIndexInfo', globalSecondaryIndexInfo_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.

$sel:indexName:GlobalSecondaryIndexInfo', globalSecondaryIndexInfo_indexName - The name of the global secondary index.

globalSecondaryIndexInfo_provisionedThroughput :: Lens' GlobalSecondaryIndexInfo (Maybe ProvisionedThroughput) Source #

Represents the provisioned throughput settings for the specified global secondary index.

globalSecondaryIndexInfo_keySchema :: Lens' GlobalSecondaryIndexInfo (Maybe (NonEmpty KeySchemaElement)) Source #

The complete key schema for a global 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.

globalSecondaryIndexInfo_projection :: Lens' GlobalSecondaryIndexInfo (Maybe Projection) Source #

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.