Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction

Description

Documentation

data CreateGlobalSecondaryIndexAction Source #

Represents a new global secondary index to be added to an existing table.

See: newCreateGlobalSecondaryIndexAction smart constructor.

Constructors

CreateGlobalSecondaryIndexAction'

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 to be created.
keySchema :: NonEmpty KeySchemaElement
The key schema for the global secondary index.
projection :: Projection
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Instances

Instances details

ToJSON CreateGlobalSecondaryIndexAction Source #
Instance details Defined in Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction Methods toJSON :: CreateGlobalSecondaryIndexAction -> Value # toEncoding :: CreateGlobalSecondaryIndexAction -> Encoding # toJSONList :: [CreateGlobalSecondaryIndexAction] -> Value # toEncodingList :: [CreateGlobalSecondaryIndexAction] -> Encoding #
Generic CreateGlobalSecondaryIndexAction Source #
Instance details Defined in Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction Associated Types type Rep CreateGlobalSecondaryIndexAction :: Type -> Type # Methods from :: CreateGlobalSecondaryIndexAction -> Rep CreateGlobalSecondaryIndexAction x # to :: Rep CreateGlobalSecondaryIndexAction x -> CreateGlobalSecondaryIndexAction #
Read CreateGlobalSecondaryIndexAction Source #
Instance details Defined in Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction Methods readsPrec :: Int -> ReadS CreateGlobalSecondaryIndexAction # readList :: ReadS [CreateGlobalSecondaryIndexAction] # readPrec :: ReadPrec CreateGlobalSecondaryIndexAction # readListPrec :: ReadPrec [CreateGlobalSecondaryIndexAction] #
Show CreateGlobalSecondaryIndexAction Source #
Instance details Defined in Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction Methods showsPrec :: Int -> CreateGlobalSecondaryIndexAction -> ShowS # show :: CreateGlobalSecondaryIndexAction -> String # showList :: [CreateGlobalSecondaryIndexAction] -> ShowS #
NFData CreateGlobalSecondaryIndexAction Source #
Instance details Defined in Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction Methods rnf :: CreateGlobalSecondaryIndexAction -> () #
Eq CreateGlobalSecondaryIndexAction Source #
Instance details Defined in Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction Methods (==) :: CreateGlobalSecondaryIndexAction -> CreateGlobalSecondaryIndexAction -> Bool # (/=) :: CreateGlobalSecondaryIndexAction -> CreateGlobalSecondaryIndexAction -> Bool #
Hashable CreateGlobalSecondaryIndexAction Source #
Instance details Defined in Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction Methods hashWithSalt :: Int -> CreateGlobalSecondaryIndexAction -> Int # hash :: CreateGlobalSecondaryIndexAction -> Int #
type Rep CreateGlobalSecondaryIndexAction Source #
Instance details Defined in Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction type Rep CreateGlobalSecondaryIndexAction = D1 ('MetaData "CreateGlobalSecondaryIndexAction" "Amazonka.DynamoDB.Types.CreateGlobalSecondaryIndexAction" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "CreateGlobalSecondaryIndexAction'" '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))))

newCreateGlobalSecondaryIndexAction Source #

Arguments

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

Create a value of CreateGlobalSecondaryIndexAction 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:CreateGlobalSecondaryIndexAction', createGlobalSecondaryIndexAction_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:CreateGlobalSecondaryIndexAction', createGlobalSecondaryIndexAction_indexName - The name of the global secondary index to be created.

$sel:keySchema:CreateGlobalSecondaryIndexAction', createGlobalSecondaryIndexAction_keySchema - The key schema for the global secondary index.

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

createGlobalSecondaryIndexAction_provisionedThroughput :: Lens' CreateGlobalSecondaryIndexAction (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.

createGlobalSecondaryIndexAction_indexName :: Lens' CreateGlobalSecondaryIndexAction Text Source #

The name of the global secondary index to be created.

createGlobalSecondaryIndexAction_keySchema :: Lens' CreateGlobalSecondaryIndexAction (NonEmpty KeySchemaElement) Source #

The key schema for the global secondary index.

createGlobalSecondaryIndexAction_projection :: Lens' CreateGlobalSecondaryIndexAction Projection Source #

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