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

Description

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name 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.

Synopsis

Creating a Request

data ResetDBParameterGroup Source #

See: newResetDBParameterGroup smart constructor.

Constructors

ResetDBParameterGroup' 

Fields

  • resetAllParameters :: Maybe Bool

    A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

  • parameters :: Maybe [Parameter]

    To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    MySQL

    Valid Values (for Apply method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

    MariaDB

    Valid Values (for Apply method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

    Oracle

    Valid Values (for Apply method): pending-reboot

  • dbParameterGroupName :: Text

    The name of the DB parameter group.

    Constraints:

    • Must match the name of an existing DBParameterGroup.

Instances

Instances details
Eq ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Methods

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

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

Read ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Methods

readsPrec :: Int -> ReadS ResetDBParameterGroup #

readList :: ReadS [ResetDBParameterGroup] #

readPrec :: ReadPrec ResetDBParameterGroup #

readListPrec :: ReadPrec [ResetDBParameterGroup] #

Show ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Methods

showsPrec :: Int -> ResetDBParameterGroup -> ShowS #

show :: ResetDBParameterGroup -> String #

showList :: [ResetDBParameterGroup] -> ShowS #

Generic ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Associated Types

type Rep ResetDBParameterGroup :: Type -> Type #

Methods

from :: ResetDBParameterGroup -> Rep ResetDBParameterGroup x #

to :: Rep ResetDBParameterGroup x -> ResetDBParameterGroup #

NFData ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Methods

rnf :: ResetDBParameterGroup -> () #

Hashable ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Methods

hashWithSalt :: Int -> ResetDBParameterGroup -> Int #

hash :: ResetDBParameterGroup -> Int #

AWSRequest ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Associated Types

type AWSResponse ResetDBParameterGroup #

Methods

request :: ResetDBParameterGroup -> Request ResetDBParameterGroup #

response :: MonadResource m => Logger -> Service -> Proxy ResetDBParameterGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ResetDBParameterGroup))) #

ToHeaders ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Methods

toHeaders :: ResetDBParameterGroup -> [Header] #

ToPath ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Methods

toPath :: ResetDBParameterGroup -> ByteString #

ToQuery ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

Methods

toQuery :: ResetDBParameterGroup -> QueryString #

type Rep ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

type Rep ResetDBParameterGroup = D1 ('MetaData "ResetDBParameterGroup" "Amazonka.RDS.ResetDBParameterGroup" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "ResetDBParameterGroup'" '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 "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ResetDBParameterGroup

type AWSResponse ResetDBParameterGroup = DBParameterGroupNameMessage

newResetDBParameterGroup Source #

Arguments

:: Text

$sel:dbParameterGroupName:ResetDBParameterGroup'

-> ResetDBParameterGroup 

Create a value of ResetDBParameterGroup 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:ResetDBParameterGroup', resetDBParameterGroup_resetAllParameters - A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

$sel:parameters:ResetDBParameterGroup', resetDBParameterGroup_parameters - To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

MariaDB

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

$sel:dbParameterGroupName:ResetDBParameterGroup', resetDBParameterGroup_dbParameterGroupName - The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

Request Lenses

resetDBParameterGroup_resetAllParameters :: Lens' ResetDBParameterGroup (Maybe Bool) Source #

A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

resetDBParameterGroup_parameters :: Lens' ResetDBParameterGroup (Maybe [Parameter]) Source #

To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

MariaDB

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

resetDBParameterGroup_dbParameterGroupName :: Lens' ResetDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

Destructuring the Response

data DBParameterGroupNameMessage Source #

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

See: newDBParameterGroupNameMessage smart constructor.

Constructors

DBParameterGroupNameMessage' 

Fields

Instances

Instances details
Eq DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Methods

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

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

Read DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Methods

readsPrec :: Int -> ReadS DBParameterGroupNameMessage #

readList :: ReadS [DBParameterGroupNameMessage] #

readPrec :: ReadPrec DBParameterGroupNameMessage #

readListPrec :: ReadPrec [DBParameterGroupNameMessage] #

Show DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Methods

showsPrec :: Int -> DBParameterGroupNameMessage -> ShowS #

show :: DBParameterGroupNameMessage -> String #

showList :: [DBParameterGroupNameMessage] -> ShowS #

Generic DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Associated Types

type Rep DBParameterGroupNameMessage :: Type -> Type #

Methods

from :: DBParameterGroupNameMessage -> Rep DBParameterGroupNameMessage x #

to :: Rep DBParameterGroupNameMessage x -> DBParameterGroupNameMessage #

NFData DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Methods

rnf :: DBParameterGroupNameMessage -> () #

Hashable DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Methods

hashWithSalt :: Int -> DBParameterGroupNameMessage -> Int #

hash :: DBParameterGroupNameMessage -> Int #

FromXML DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Methods

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

type Rep DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

type Rep DBParameterGroupNameMessage = D1 ('MetaData "DBParameterGroupNameMessage" "Amazonka.RDS.Types.DBParameterGroupNameMessage" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DBParameterGroupNameMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBParameterGroupNameMessage :: DBParameterGroupNameMessage Source #

Create a value of DBParameterGroupNameMessage 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:dbParameterGroupName:DBParameterGroupNameMessage', dbParameterGroupNameMessage_dbParameterGroupName - The name of the DB parameter group.

Response Lenses

dbParameterGroupNameMessage_dbParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text) Source #

The name of the DB parameter group.