libZSservicesZSamazonka-rdsZSamazonka-rds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RDS.ResetDBClusterParameterGroup

Description

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

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Synopsis

Creating a Request

data ResetDBClusterParameterGroup Source #

See: newResetDBClusterParameterGroup smart constructor.

Constructors

ResetDBClusterParameterGroup' 

Fields

  • resetAllParameters :: Maybe Bool

    A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. 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 DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.

  • dbClusterParameterGroupName :: Text

    The name of the DB cluster parameter group to reset.

Instances

Instances details
Eq ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBClusterParameterGroup

Methods

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

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

Read ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBClusterParameterGroup

Methods

readsPrec :: Int -> ReadS ResetDBClusterParameterGroup #

readList :: ReadS [ResetDBClusterParameterGroup] #

readPrec :: ReadPrec ResetDBClusterParameterGroup #

readListPrec :: ReadPrec [ResetDBClusterParameterGroup] #

Show ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBClusterParameterGroup

Methods

showsPrec :: Int -> ResetDBClusterParameterGroup -> ShowS #

show :: ResetDBClusterParameterGroup -> String #

showList :: [ResetDBClusterParameterGroup] -> ShowS #

Generic ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.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.RDS.ResetDBClusterParameterGroup

Methods

rnf :: ResetDBClusterParameterGroup -> () #

Hashable ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBClusterParameterGroup

Methods

hashWithSalt :: Int -> ResetDBClusterParameterGroup -> Int #

hash :: ResetDBClusterParameterGroup -> Int #

AWSRequest ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.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.RDS.ResetDBClusterParameterGroup

Methods

toHeaders :: ResetDBClusterParameterGroup -> [Header] #

ToPath ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBClusterParameterGroup

Methods

toPath :: ResetDBClusterParameterGroup -> ByteString #

ToQuery ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBClusterParameterGroup

Methods

toQuery :: ResetDBClusterParameterGroup -> QueryString #

type Rep ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBClusterParameterGroup

type Rep ResetDBClusterParameterGroup = D1 ('MetaData "ResetDBClusterParameterGroup" "Amazonka.RDS.ResetDBClusterParameterGroup" "libZSservicesZSamazonka-rdsZSamazonka-rds" '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.RDS.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 indicates whether to reset all parameters in the DB cluster parameter group to their default values. 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 DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.

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

Request Lenses

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

A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. 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 DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.

resetDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ResetDBClusterParameterGroup Text Source #

The name of the DB cluster parameter group to reset.

Destructuring the Response

data DBClusterParameterGroupNameMessage Source #

See: newDBClusterParameterGroupNameMessage smart constructor.

Constructors

DBClusterParameterGroupNameMessage' 

Fields

  • dbClusterParameterGroupName :: Maybe Text

    The name of the DB cluster parameter group.

    Constraints:

    • Must be 1 to 255 letters or numbers.
    • First character must be a letter
    • Can't 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.RDS.Types.DBClusterParameterGroupNameMessage

Methods

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

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

Read DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

Methods

readsPrec :: Int -> ReadS DBClusterParameterGroupNameMessage #

readList :: ReadS [DBClusterParameterGroupNameMessage] #

readPrec :: ReadPrec DBClusterParameterGroupNameMessage #

readListPrec :: ReadPrec [DBClusterParameterGroupNameMessage] #

Show DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

Methods

showsPrec :: Int -> DBClusterParameterGroupNameMessage -> ShowS #

show :: DBClusterParameterGroupNameMessage -> String #

showList :: [DBClusterParameterGroupNameMessage] -> ShowS #

Generic DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.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.RDS.Types.DBClusterParameterGroupNameMessage

Methods

rnf :: DBClusterParameterGroupNameMessage -> () #

Hashable DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

Methods

hashWithSalt :: Int -> DBClusterParameterGroupNameMessage -> Int #

hash :: DBClusterParameterGroupNameMessage -> Int #

FromXML DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

Methods

parseXML :: [Node] -> Either String DBClusterParameterGroupNameMessage #

type Rep DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.RDS.Types.DBClusterParameterGroupNameMessage" "libZSservicesZSamazonka-rdsZSamazonka-rds" '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 the DB cluster parameter group.

Constraints:

  • Must be 1 to 255 letters or numbers.
  • First character must be a letter
  • Can't 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 the DB cluster parameter group.

Constraints:

  • Must be 1 to 255 letters or numbers.
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.