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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates settings for a global table.

Synopsis

Creating a Request

data UpdateGlobalTableSettings Source #

See: newUpdateGlobalTableSettings smart constructor.

Constructors

UpdateGlobalTableSettings'

Fields

globalTableBillingMode :: Maybe BillingMode
The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.
- PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
- PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.
globalTableGlobalSecondaryIndexSettingsUpdate :: Maybe (NonEmpty GlobalTableGlobalSecondaryIndexSettingsUpdate)
Represents the settings of a global secondary index for a global table that will be modified.
globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate :: Maybe AutoScalingSettingsUpdate
Auto scaling settings for managing provisioned write capacity for the global table.
globalTableProvisionedWriteCapacityUnits :: Maybe Natural
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
replicaSettingsUpdate :: Maybe (NonEmpty ReplicaSettingsUpdate)
Represents the settings for a global table in a Region that will be modified.
globalTableName :: Text
The name of the global table

Instances

Instances details

ToJSON UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods toJSON :: UpdateGlobalTableSettings -> Value # toEncoding :: UpdateGlobalTableSettings -> Encoding # toJSONList :: [UpdateGlobalTableSettings] -> Value # toEncodingList :: [UpdateGlobalTableSettings] -> Encoding #
ToHeaders UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods toHeaders :: UpdateGlobalTableSettings -> [Header] #
ToPath UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods toPath :: UpdateGlobalTableSettings -> ByteString #
ToQuery UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods toQuery :: UpdateGlobalTableSettings -> QueryString #
AWSRequest UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Associated Types type AWSResponse UpdateGlobalTableSettings # Methods request :: (Service -> Service) -> UpdateGlobalTableSettings -> Request UpdateGlobalTableSettings # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateGlobalTableSettings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGlobalTableSettings))) #
Generic UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Associated Types type Rep UpdateGlobalTableSettings :: Type -> Type # Methods from :: UpdateGlobalTableSettings -> Rep UpdateGlobalTableSettings x # to :: Rep UpdateGlobalTableSettings x -> UpdateGlobalTableSettings #
Read UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods readsPrec :: Int -> ReadS UpdateGlobalTableSettings # readList :: ReadS [UpdateGlobalTableSettings] # readPrec :: ReadPrec UpdateGlobalTableSettings # readListPrec :: ReadPrec [UpdateGlobalTableSettings] #
Show UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods showsPrec :: Int -> UpdateGlobalTableSettings -> ShowS # show :: UpdateGlobalTableSettings -> String # showList :: [UpdateGlobalTableSettings] -> ShowS #
NFData UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods rnf :: UpdateGlobalTableSettings -> () #
Eq UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods (==) :: UpdateGlobalTableSettings -> UpdateGlobalTableSettings -> Bool # (/=) :: UpdateGlobalTableSettings -> UpdateGlobalTableSettings -> Bool #
Hashable UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods hashWithSalt :: Int -> UpdateGlobalTableSettings -> Int # hash :: UpdateGlobalTableSettings -> Int #
type AWSResponse UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings type AWSResponse UpdateGlobalTableSettings = UpdateGlobalTableSettingsResponse
type Rep UpdateGlobalTableSettings Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings type Rep UpdateGlobalTableSettings = D1 ('MetaData "UpdateGlobalTableSettings" "Amazonka.DynamoDB.UpdateGlobalTableSettings" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "UpdateGlobalTableSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "globalTableBillingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BillingMode)) :: (S1 ('MetaSel ('Just "globalTableGlobalSecondaryIndexSettingsUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty GlobalTableGlobalSecondaryIndexSettingsUpdate))) :: S1 ('MetaSel ('Just "globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoScalingSettingsUpdate)))) :: (S1 ('MetaSel ('Just "globalTableProvisionedWriteCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "replicaSettingsUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ReplicaSettingsUpdate))) :*: S1 ('MetaSel ('Just "globalTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateGlobalTableSettings Source #

Arguments

:: Text	`UpdateGlobalTableSettings`
-> UpdateGlobalTableSettings

Create a value of UpdateGlobalTableSettings 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:globalTableBillingMode:UpdateGlobalTableSettings', updateGlobalTableSettings_globalTableBillingMode - The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

$sel:globalTableGlobalSecondaryIndexSettingsUpdate:UpdateGlobalTableSettings', updateGlobalTableSettings_globalTableGlobalSecondaryIndexSettingsUpdate - Represents the settings of a global secondary index for a global table that will be modified.

$sel:globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate:UpdateGlobalTableSettings', updateGlobalTableSettings_globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate - Auto scaling settings for managing provisioned write capacity for the global table.

$sel:globalTableProvisionedWriteCapacityUnits:UpdateGlobalTableSettings', updateGlobalTableSettings_globalTableProvisionedWriteCapacityUnits - The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

$sel:replicaSettingsUpdate:UpdateGlobalTableSettings', updateGlobalTableSettings_replicaSettingsUpdate - Represents the settings for a global table in a Region that will be modified.

UpdateGlobalTableSettings, updateGlobalTableSettings_globalTableName - The name of the global table

Request Lenses

updateGlobalTableSettings_globalTableBillingMode :: Lens' UpdateGlobalTableSettings (Maybe BillingMode) Source #

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode.

updateGlobalTableSettings_globalTableGlobalSecondaryIndexSettingsUpdate :: Lens' UpdateGlobalTableSettings (Maybe (NonEmpty GlobalTableGlobalSecondaryIndexSettingsUpdate)) Source #

Represents the settings of a global secondary index for a global table that will be modified.

updateGlobalTableSettings_globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate :: Lens' UpdateGlobalTableSettings (Maybe AutoScalingSettingsUpdate) Source #

Auto scaling settings for managing provisioned write capacity for the global table.

updateGlobalTableSettings_globalTableProvisionedWriteCapacityUnits :: Lens' UpdateGlobalTableSettings (Maybe Natural) Source #

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

updateGlobalTableSettings_replicaSettingsUpdate :: Lens' UpdateGlobalTableSettings (Maybe (NonEmpty ReplicaSettingsUpdate)) Source #

Represents the settings for a global table in a Region that will be modified.

updateGlobalTableSettings_globalTableName :: Lens' UpdateGlobalTableSettings Text Source #

The name of the global table

Destructuring the Response

data UpdateGlobalTableSettingsResponse Source #

See: newUpdateGlobalTableSettingsResponse smart constructor.

Constructors

UpdateGlobalTableSettingsResponse'
Fields globalTableName :: Maybe Text The name of the global table. replicaSettings :: Maybe [ReplicaSettingsDescription] The Region-specific settings for the global table. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateGlobalTableSettingsResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Associated Types type Rep UpdateGlobalTableSettingsResponse :: Type -> Type # Methods from :: UpdateGlobalTableSettingsResponse -> Rep UpdateGlobalTableSettingsResponse x # to :: Rep UpdateGlobalTableSettingsResponse x -> UpdateGlobalTableSettingsResponse #
Read UpdateGlobalTableSettingsResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods readsPrec :: Int -> ReadS UpdateGlobalTableSettingsResponse # readList :: ReadS [UpdateGlobalTableSettingsResponse] # readPrec :: ReadPrec UpdateGlobalTableSettingsResponse # readListPrec :: ReadPrec [UpdateGlobalTableSettingsResponse] #
Show UpdateGlobalTableSettingsResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods showsPrec :: Int -> UpdateGlobalTableSettingsResponse -> ShowS # show :: UpdateGlobalTableSettingsResponse -> String # showList :: [UpdateGlobalTableSettingsResponse] -> ShowS #
NFData UpdateGlobalTableSettingsResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods rnf :: UpdateGlobalTableSettingsResponse -> () #
Eq UpdateGlobalTableSettingsResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings Methods (==) :: UpdateGlobalTableSettingsResponse -> UpdateGlobalTableSettingsResponse -> Bool # (/=) :: UpdateGlobalTableSettingsResponse -> UpdateGlobalTableSettingsResponse -> Bool #
type Rep UpdateGlobalTableSettingsResponse Source #
Instance details Defined in Amazonka.DynamoDB.UpdateGlobalTableSettings type Rep UpdateGlobalTableSettingsResponse = D1 ('MetaData "UpdateGlobalTableSettingsResponse" "Amazonka.DynamoDB.UpdateGlobalTableSettings" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "UpdateGlobalTableSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "replicaSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicaSettingsDescription])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateGlobalTableSettingsResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateGlobalTableSettingsResponse'`
-> UpdateGlobalTableSettingsResponse

Create a value of UpdateGlobalTableSettingsResponse 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:

UpdateGlobalTableSettings, updateGlobalTableSettingsResponse_globalTableName - The name of the global table.

$sel:replicaSettings:UpdateGlobalTableSettingsResponse', updateGlobalTableSettingsResponse_replicaSettings - The Region-specific settings for the global table.

$sel:httpStatus:UpdateGlobalTableSettingsResponse', updateGlobalTableSettingsResponse_httpStatus - The response's http status code.

Response Lenses

updateGlobalTableSettingsResponse_globalTableName :: Lens' UpdateGlobalTableSettingsResponse (Maybe Text) Source #

The name of the global table.

updateGlobalTableSettingsResponse_replicaSettings :: Lens' UpdateGlobalTableSettingsResponse (Maybe [ReplicaSettingsDescription]) Source #

The Region-specific settings for the global table.

updateGlobalTableSettingsResponse_httpStatus :: Lens' UpdateGlobalTableSettingsResponse Int Source #

The response's http status code.