amazonka-docdb-2.0: Amazon DocumentDB with MongoDB compatibility SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DocumentDB.ModifyGlobalCluster

Description

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.

This action only applies to Amazon DocumentDB clusters.

Synopsis

Creating a Request

data ModifyGlobalCluster Source #

Represents the input to ModifyGlobalCluster.

See: newModifyGlobalCluster smart constructor.

Constructors

ModifyGlobalCluster' 

Fields

  • deletionProtection :: Maybe Bool

    Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

  • newGlobalClusterIdentifier' :: Maybe Text

    The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

    • Must contain from 1 to 63 letters, numbers, or hyphens

      The first character must be a letter

      Can't end with a hyphen or contain two consecutive hyphens

    Example: my-cluster2

  • globalClusterIdentifier :: Text

    The identifier for the global cluster being modified. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing global cluster.

Instances

Instances details
ToHeaders ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

toHeaders :: ModifyGlobalCluster -> [Header] #

ToPath ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

toPath :: ModifyGlobalCluster -> ByteString #

ToQuery ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

toQuery :: ModifyGlobalCluster -> QueryString #

AWSRequest ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Associated Types

type AWSResponse ModifyGlobalCluster #

Methods

request :: (Service -> Service) -> ModifyGlobalCluster -> Request ModifyGlobalCluster #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyGlobalCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyGlobalCluster))) #

Generic ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Associated Types

type Rep ModifyGlobalCluster :: Type -> Type #

Methods

from :: ModifyGlobalCluster -> Rep ModifyGlobalCluster x #

to :: Rep ModifyGlobalCluster x -> ModifyGlobalCluster #

Read ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

readsPrec :: Int -> ReadS ModifyGlobalCluster #

readList :: ReadS [ModifyGlobalCluster] #

readPrec :: ReadPrec ModifyGlobalCluster #

readListPrec :: ReadPrec [ModifyGlobalCluster] #

Show ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

showsPrec :: Int -> ModifyGlobalCluster -> ShowS #

show :: ModifyGlobalCluster -> String #

showList :: [ModifyGlobalCluster] -> ShowS #

NFData ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

rnf :: ModifyGlobalCluster -> () #

Eq ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

(==) :: ModifyGlobalCluster -> ModifyGlobalCluster -> Bool #

(/=) :: ModifyGlobalCluster -> ModifyGlobalCluster -> Bool #

Hashable ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

hashWithSalt :: Int -> ModifyGlobalCluster -> Int #

hash :: ModifyGlobalCluster -> Int #

type AWSResponse ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

type AWSResponse ModifyGlobalCluster = ModifyGlobalClusterResponse
type Rep ModifyGlobalCluster Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

type Rep ModifyGlobalCluster = D1 ('MetaData "ModifyGlobalCluster" "Amazonka.DocumentDB.ModifyGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyGlobalCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "newGlobalClusterIdentifier'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newModifyGlobalCluster Source #

Arguments

:: Text

ModifyGlobalCluster

-> ModifyGlobalCluster 

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

ModifyGlobalCluster, modifyGlobalCluster_deletionProtection - Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

$sel:newGlobalClusterIdentifier':ModifyGlobalCluster', modifyGlobalCluster_newGlobalClusterIdentifier - The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

  • Must contain from 1 to 63 letters, numbers, or hyphens

    The first character must be a letter

    Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

ModifyGlobalCluster, modifyGlobalCluster_globalClusterIdentifier - The identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

  • Must match the identifier of an existing global cluster.

Request Lenses

modifyGlobalCluster_deletionProtection :: Lens' ModifyGlobalCluster (Maybe Bool) Source #

Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

modifyGlobalCluster_newGlobalClusterIdentifier :: Lens' ModifyGlobalCluster (Maybe Text) Source #

The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

  • Must contain from 1 to 63 letters, numbers, or hyphens

    The first character must be a letter

    Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

modifyGlobalCluster_globalClusterIdentifier :: Lens' ModifyGlobalCluster Text Source #

The identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

  • Must match the identifier of an existing global cluster.

Destructuring the Response

data ModifyGlobalClusterResponse Source #

See: newModifyGlobalClusterResponse smart constructor.

Constructors

ModifyGlobalClusterResponse' 

Fields

Instances

Instances details
Generic ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Associated Types

type Rep ModifyGlobalClusterResponse :: Type -> Type #

Methods

from :: ModifyGlobalClusterResponse -> Rep ModifyGlobalClusterResponse x #

to :: Rep ModifyGlobalClusterResponse x -> ModifyGlobalClusterResponse #

Read ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

readsPrec :: Int -> ReadS ModifyGlobalClusterResponse #

readList :: ReadS [ModifyGlobalClusterResponse] #

readPrec :: ReadPrec ModifyGlobalClusterResponse #

readListPrec :: ReadPrec [ModifyGlobalClusterResponse] #

Show ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

showsPrec :: Int -> ModifyGlobalClusterResponse -> ShowS #

show :: ModifyGlobalClusterResponse -> String #

showList :: [ModifyGlobalClusterResponse] -> ShowS #

NFData ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

rnf :: ModifyGlobalClusterResponse -> () #

Eq ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

Methods

(==) :: ModifyGlobalClusterResponse -> ModifyGlobalClusterResponse -> Bool #

(/=) :: ModifyGlobalClusterResponse -> ModifyGlobalClusterResponse -> Bool #

type Rep ModifyGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.ModifyGlobalCluster

type Rep ModifyGlobalClusterResponse = D1 ('MetaData "ModifyGlobalClusterResponse" "Amazonka.DocumentDB.ModifyGlobalCluster" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyGlobalClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyGlobalClusterResponse Source #

Arguments

:: Int

$sel:httpStatus:ModifyGlobalClusterResponse'

-> ModifyGlobalClusterResponse 

Create a value of ModifyGlobalClusterResponse 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:globalCluster:ModifyGlobalClusterResponse', modifyGlobalClusterResponse_globalCluster - Undocumented member.

$sel:httpStatus:ModifyGlobalClusterResponse', modifyGlobalClusterResponse_httpStatus - The response's http status code.

Response Lenses

modifyGlobalClusterResponse_globalCluster :: Lens' ModifyGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

modifyGlobalClusterResponse_httpStatus :: Lens' ModifyGlobalClusterResponse Int Source #

The response's http status code.