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.DocumentDB.ModifyDBClusterParameterGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

Creating a Request

data ModifyDBClusterParameterGroup Source #

Represents the input to ModifyDBClusterParameterGroup.

See: newModifyDBClusterParameterGroup smart constructor.

Constructors

ModifyDBClusterParameterGroup'
Fields dbClusterParameterGroupName :: Text The name of the cluster parameter group to modify. parameters :: [Parameter] A list of parameters in the cluster parameter group to modify.

Instances

Instances details

ToHeaders ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Methods toHeaders :: ModifyDBClusterParameterGroup -> [Header] #
ToPath ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Methods toPath :: ModifyDBClusterParameterGroup -> ByteString #
ToQuery ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Methods toQuery :: ModifyDBClusterParameterGroup -> QueryString #
AWSRequest ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Associated Types type AWSResponse ModifyDBClusterParameterGroup # Methods request :: (Service -> Service) -> ModifyDBClusterParameterGroup -> Request ModifyDBClusterParameterGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyDBClusterParameterGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyDBClusterParameterGroup))) #
Generic ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Associated Types type Rep ModifyDBClusterParameterGroup :: Type -> Type # Methods from :: ModifyDBClusterParameterGroup -> Rep ModifyDBClusterParameterGroup x # to :: Rep ModifyDBClusterParameterGroup x -> ModifyDBClusterParameterGroup #
Read ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Methods readsPrec :: Int -> ReadS ModifyDBClusterParameterGroup # readList :: ReadS [ModifyDBClusterParameterGroup] # readPrec :: ReadPrec ModifyDBClusterParameterGroup # readListPrec :: ReadPrec [ModifyDBClusterParameterGroup] #
Show ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Methods showsPrec :: Int -> ModifyDBClusterParameterGroup -> ShowS # show :: ModifyDBClusterParameterGroup -> String # showList :: [ModifyDBClusterParameterGroup] -> ShowS #
NFData ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Methods rnf :: ModifyDBClusterParameterGroup -> () #
Eq ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Methods (==) :: ModifyDBClusterParameterGroup -> ModifyDBClusterParameterGroup -> Bool # (/=) :: ModifyDBClusterParameterGroup -> ModifyDBClusterParameterGroup -> Bool #
Hashable ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup Methods hashWithSalt :: Int -> ModifyDBClusterParameterGroup -> Int # hash :: ModifyDBClusterParameterGroup -> Int #
type AWSResponse ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup type AWSResponse ModifyDBClusterParameterGroup = DBClusterParameterGroupNameMessage
type Rep ModifyDBClusterParameterGroup Source #
Instance details Defined in Amazonka.DocumentDB.ModifyDBClusterParameterGroup type Rep ModifyDBClusterParameterGroup = D1 ('MetaData "ModifyDBClusterParameterGroup" "Amazonka.DocumentDB.ModifyDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyDBClusterParameterGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Parameter])))

newModifyDBClusterParameterGroup Source #

Arguments

:: Text	`ModifyDBClusterParameterGroup`
-> ModifyDBClusterParameterGroup

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

ModifyDBClusterParameterGroup, modifyDBClusterParameterGroup_dbClusterParameterGroupName - The name of the cluster parameter group to modify.

ModifyDBClusterParameterGroup, modifyDBClusterParameterGroup_parameters - A list of parameters in the cluster parameter group to modify.

Request Lenses

modifyDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ModifyDBClusterParameterGroup Text Source #

The name of the cluster parameter group to modify.

modifyDBClusterParameterGroup_parameters :: Lens' ModifyDBClusterParameterGroup [Parameter] Source #

A list of parameters in the cluster parameter group to modify.

Destructuring the Response

data DBClusterParameterGroupNameMessage Source #

Contains the name of a cluster parameter group.

See: newDBClusterParameterGroupNameMessage smart constructor.

Constructors

DBClusterParameterGroupNameMessage'
Fields dbClusterParameterGroupName :: Maybe Text The name of a cluster parameter group. Constraints: Must be from 1 to 255 letters or numbers. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. This value is stored as a lowercase string.

Instances

Instances details

FromXML DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods parseXML :: [Node] -> Either String DBClusterParameterGroupNameMessage #
Generic DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Associated Types type Rep DBClusterParameterGroupNameMessage :: Type -> Type # Methods from :: DBClusterParameterGroupNameMessage -> Rep DBClusterParameterGroupNameMessage x # to :: Rep DBClusterParameterGroupNameMessage x -> DBClusterParameterGroupNameMessage #
Read DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods readsPrec :: Int -> ReadS DBClusterParameterGroupNameMessage # readList :: ReadS [DBClusterParameterGroupNameMessage] # readPrec :: ReadPrec DBClusterParameterGroupNameMessage # readListPrec :: ReadPrec [DBClusterParameterGroupNameMessage] #
Show DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods showsPrec :: Int -> DBClusterParameterGroupNameMessage -> ShowS # show :: DBClusterParameterGroupNameMessage -> String # showList :: [DBClusterParameterGroupNameMessage] -> ShowS #
NFData DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods rnf :: DBClusterParameterGroupNameMessage -> () #
Eq DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods (==) :: DBClusterParameterGroupNameMessage -> DBClusterParameterGroupNameMessage -> Bool # (/=) :: DBClusterParameterGroupNameMessage -> DBClusterParameterGroupNameMessage -> Bool #
Hashable DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods hashWithSalt :: Int -> DBClusterParameterGroupNameMessage -> Int # hash :: DBClusterParameterGroupNameMessage -> Int #
type Rep DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DBClusterParameterGroupNameMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage Source #

Create a value of DBClusterParameterGroupNameMessage 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:dbClusterParameterGroupName:DBClusterParameterGroupNameMessage', dbClusterParameterGroupNameMessage_dbClusterParameterGroupName - The name of a cluster parameter group.

Constraints:

Must be from 1 to 255 letters or numbers.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

Response Lenses

dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source #

The name of a cluster parameter group.

Constraints:

Must be from 1 to 255 letters or numbers.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.