amazonka-neptune-2.0: Amazon Neptune 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.Neptune.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

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

    Valid Values (for Apply method): pending-reboot

  • resetAllParameters :: Maybe Bool

    Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

    Default: true

  • dbParameterGroupName :: Text

    The name of the DB parameter group.

    Constraints:

    • Must match the name of an existing DBParameterGroup.

Instances

Instances details
ToHeaders ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Methods

toHeaders :: ResetDBParameterGroup -> [Header] #

ToPath ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Methods

toPath :: ResetDBParameterGroup -> ByteString #

ToQuery ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Methods

toQuery :: ResetDBParameterGroup -> QueryString #

AWSRequest ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Associated Types

type AWSResponse ResetDBParameterGroup #

Methods

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

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

Generic ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Associated Types

type Rep ResetDBParameterGroup :: Type -> Type #

Methods

from :: ResetDBParameterGroup -> Rep ResetDBParameterGroup x #

to :: Rep ResetDBParameterGroup x -> ResetDBParameterGroup #

Read ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Methods

readsPrec :: Int -> ReadS ResetDBParameterGroup #

readList :: ReadS [ResetDBParameterGroup] #

readPrec :: ReadPrec ResetDBParameterGroup #

readListPrec :: ReadPrec [ResetDBParameterGroup] #

Show ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Methods

showsPrec :: Int -> ResetDBParameterGroup -> ShowS #

show :: ResetDBParameterGroup -> String #

showList :: [ResetDBParameterGroup] -> ShowS #

NFData ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Methods

rnf :: ResetDBParameterGroup -> () #

Eq ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Methods

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

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

Hashable ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

Methods

hashWithSalt :: Int -> ResetDBParameterGroup -> Int #

hash :: ResetDBParameterGroup -> Int #

type AWSResponse ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

type AWSResponse ResetDBParameterGroup = DBParameterGroupNameMessage
type Rep ResetDBParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBParameterGroup

type Rep ResetDBParameterGroup = D1 ('MetaData "ResetDBParameterGroup" "Amazonka.Neptune.ResetDBParameterGroup" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "ResetDBParameterGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :*: (S1 ('MetaSel ('Just "resetAllParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newResetDBParameterGroup Source #

Arguments

:: Text

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:

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.

Valid Values (for Apply method): pending-reboot

$sel:resetAllParameters:ResetDBParameterGroup', resetDBParameterGroup_resetAllParameters - Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

ResetDBParameterGroup, resetDBParameterGroup_dbParameterGroupName - The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

Request Lenses

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.

Valid Values (for Apply method): pending-reboot

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

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

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 #

See: newDBParameterGroupNameMessage smart constructor.

Constructors

DBParameterGroupNameMessage' 

Fields

Instances

Instances details
FromXML DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBParameterGroupNameMessage

Methods

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

Generic DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBParameterGroupNameMessage

Associated Types

type Rep DBParameterGroupNameMessage :: Type -> Type #

Methods

from :: DBParameterGroupNameMessage -> Rep DBParameterGroupNameMessage x #

to :: Rep DBParameterGroupNameMessage x -> DBParameterGroupNameMessage #

Read DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBParameterGroupNameMessage

Methods

readsPrec :: Int -> ReadS DBParameterGroupNameMessage #

readList :: ReadS [DBParameterGroupNameMessage] #

readPrec :: ReadPrec DBParameterGroupNameMessage #

readListPrec :: ReadPrec [DBParameterGroupNameMessage] #

Show DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBParameterGroupNameMessage

Methods

showsPrec :: Int -> DBParameterGroupNameMessage -> ShowS #

show :: DBParameterGroupNameMessage -> String #

showList :: [DBParameterGroupNameMessage] -> ShowS #

NFData DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBParameterGroupNameMessage

Methods

rnf :: DBParameterGroupNameMessage -> () #

Eq DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBParameterGroupNameMessage

Methods

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

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

Hashable DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBParameterGroupNameMessage

Methods

hashWithSalt :: Int -> DBParameterGroupNameMessage -> Int #

hash :: DBParameterGroupNameMessage -> Int #

type Rep DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBParameterGroupNameMessage

type Rep DBParameterGroupNameMessage = D1 ('MetaData "DBParameterGroupNameMessage" "Amazonka.Neptune.Types.DBParameterGroupNameMessage" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" '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 - Provides the name of the DB parameter group.

Response Lenses

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

Provides the name of the DB parameter group.