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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

Synopsis

data ResetDBClusterParameterGroup = ResetDBClusterParameterGroup' {
- resetAllParameters :: Maybe Bool
- parameters :: Maybe [Parameter]
- dbClusterParameterGroupName :: Text
}
newResetDBClusterParameterGroup :: Text -> ResetDBClusterParameterGroup
resetDBClusterParameterGroup_resetAllParameters :: Lens' ResetDBClusterParameterGroup (Maybe Bool)
resetDBClusterParameterGroup_parameters :: Lens' ResetDBClusterParameterGroup (Maybe [Parameter])
resetDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ResetDBClusterParameterGroup Text
data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' {
- dbClusterParameterGroupName :: Maybe Text
}
newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text)

Creating a Request

data ResetDBClusterParameterGroup Source #

Represents the input to ResetDBClusterParameterGroup.

See: newResetDBClusterParameterGroup smart constructor.

Constructors

ResetDBClusterParameterGroup'

Fields

resetAllParameters :: Maybe Bool
A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
parameters :: Maybe [Parameter]
A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.
dbClusterParameterGroupName :: Text
The name of the cluster parameter group to reset.

Instances

Instances details

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

newResetDBClusterParameterGroup Source #

Arguments

:: Text	`$sel:dbClusterParameterGroupName:ResetDBClusterParameterGroup'`
-> ResetDBClusterParameterGroup

Create a value of ResetDBClusterParameterGroup 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:resetAllParameters:ResetDBClusterParameterGroup', resetDBClusterParameterGroup_resetAllParameters - A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

$sel:parameters:ResetDBClusterParameterGroup', resetDBClusterParameterGroup_parameters - A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

$sel:dbClusterParameterGroupName:ResetDBClusterParameterGroup', resetDBClusterParameterGroup_dbClusterParameterGroupName - The name of the cluster parameter group to reset.

Request Lenses

resetDBClusterParameterGroup_resetAllParameters :: Lens' ResetDBClusterParameterGroup (Maybe Bool) Source #

A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

resetDBClusterParameterGroup_parameters :: Lens' ResetDBClusterParameterGroup (Maybe [Parameter]) Source #

A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

resetDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ResetDBClusterParameterGroup Text Source #

The name of the cluster parameter group to reset.

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

Eq DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods (==) :: DBClusterParameterGroupNameMessage -> DBClusterParameterGroupNameMessage -> Bool # (/=) :: DBClusterParameterGroupNameMessage -> DBClusterParameterGroupNameMessage -> Bool #
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 #
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 #
NFData DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods rnf :: DBClusterParameterGroupNameMessage -> () #
Hashable DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods hashWithSalt :: Int -> DBClusterParameterGroupNameMessage -> Int # hash :: DBClusterParameterGroupNameMessage -> Int #
FromXML DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage Methods parseXML :: [Node] -> Either String DBClusterParameterGroupNameMessage #
type Rep DBClusterParameterGroupNameMessage Source #
Instance details Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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.