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

Description

Documentation

data GlobalSecondaryIndex Source #

Represents the properties of a global secondary index.

See: newGlobalSecondaryIndex smart constructor.

Constructors

GlobalSecondaryIndex'

Fields

provisionedThroughput :: Maybe ProvisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
indexName :: Text
The name of the global secondary index. The name must be unique among all other indexes on this table.
keySchema :: 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 :: 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

Instances details

Eq GlobalSecondaryIndex Source #
Instance details Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndex Methods (==) :: GlobalSecondaryIndex -> GlobalSecondaryIndex -> Bool # (/=) :: GlobalSecondaryIndex -> GlobalSecondaryIndex -> Bool #
Read GlobalSecondaryIndex Source #
Instance details Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndex Methods readsPrec :: Int -> ReadS GlobalSecondaryIndex # readList :: ReadS [GlobalSecondaryIndex] # readPrec :: ReadPrec GlobalSecondaryIndex # readListPrec :: ReadPrec [GlobalSecondaryIndex] #
Show GlobalSecondaryIndex Source #
Instance details Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndex Methods showsPrec :: Int -> GlobalSecondaryIndex -> ShowS # show :: GlobalSecondaryIndex -> String # showList :: [GlobalSecondaryIndex] -> ShowS #
Generic GlobalSecondaryIndex Source #
Instance details Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndex Associated Types type Rep GlobalSecondaryIndex :: Type -> Type # Methods from :: GlobalSecondaryIndex -> Rep GlobalSecondaryIndex x # to :: Rep GlobalSecondaryIndex x -> GlobalSecondaryIndex #
NFData GlobalSecondaryIndex Source #
Instance details Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndex Methods rnf :: GlobalSecondaryIndex -> () #
Hashable GlobalSecondaryIndex Source #
Instance details Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndex Methods hashWithSalt :: Int -> GlobalSecondaryIndex -> Int # hash :: GlobalSecondaryIndex -> Int #
ToJSON GlobalSecondaryIndex Source #
Instance details Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndex Methods toJSON :: GlobalSecondaryIndex -> Value # toEncoding :: GlobalSecondaryIndex -> Encoding # toJSONList :: [GlobalSecondaryIndex] -> Value # toEncodingList :: [GlobalSecondaryIndex] -> Encoding #
type Rep GlobalSecondaryIndex Source #
Instance details Defined in Amazonka.DynamoDB.Types.GlobalSecondaryIndex type Rep GlobalSecondaryIndex = D1 ('MetaData "GlobalSecondaryIndex" "Amazonka.DynamoDB.Types.GlobalSecondaryIndex" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "GlobalSecondaryIndex'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "provisionedThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisionedThroughput)) :: 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))))

newGlobalSecondaryIndex Source #

Arguments

:: Text	`$sel:indexName:GlobalSecondaryIndex'`
-> NonEmpty KeySchemaElement	`$sel:keySchema:GlobalSecondaryIndex'`
-> Projection	`$sel:projection:GlobalSecondaryIndex'`
-> GlobalSecondaryIndex

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

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

$sel:indexName:GlobalSecondaryIndex', globalSecondaryIndex_indexName - The name of the global secondary index. The name must be unique among all other indexes on this table.

$sel:keySchema:GlobalSecondaryIndex', globalSecondaryIndex_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:GlobalSecondaryIndex', globalSecondaryIndex_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.

globalSecondaryIndex_provisionedThroughput :: Lens' GlobalSecondaryIndex (Maybe ProvisionedThroughput) Source #

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

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

globalSecondaryIndex_indexName :: Lens' GlobalSecondaryIndex Text Source #

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

globalSecondaryIndex_keySchema :: Lens' GlobalSecondaryIndex (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.

globalSecondaryIndex_projection :: Lens' GlobalSecondaryIndex 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.