libZSservicesZSamazonka-neptuneZSamazonka-neptune
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.Neptune.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.

Synopsis

Creating a Request

data ResetDBClusterParameterGroup Source #

See: newResetDBClusterParameterGroup smart constructor.

Constructors

ResetDBClusterParameterGroup' 

Fields

  • resetAllParameters :: Maybe Bool

    A value that is set to true to reset all parameters in the DB 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 DB 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 DB cluster parameter group to reset.

Instances

Instances details
Eq ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

Read ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

Show ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

Generic ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

Associated Types

type Rep ResetDBClusterParameterGroup :: Type -> Type #

NFData ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

Hashable ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

AWSRequest ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

ToHeaders ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

ToPath ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

ToQuery ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

type Rep ResetDBClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Neptune.ResetDBClusterParameterGroup

type Rep ResetDBClusterParameterGroup = D1 ('MetaData "ResetDBClusterParameterGroup" "Amazonka.Neptune.ResetDBClusterParameterGroup" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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.Neptune.ResetDBClusterParameterGroup

newResetDBClusterParameterGroup Source #

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 DB 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 DB 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 DB 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 DB 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 DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

Destructuring the Response

data DBClusterParameterGroupNameMessage Source #

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
    • 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.Neptune.Types.DBClusterParameterGroupNameMessage

Read DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBClusterParameterGroupNameMessage

Show DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBClusterParameterGroupNameMessage

Generic DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBClusterParameterGroupNameMessage

Associated Types

type Rep DBClusterParameterGroupNameMessage :: Type -> Type #

NFData DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBClusterParameterGroupNameMessage

Hashable DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBClusterParameterGroupNameMessage

FromXML DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Neptune.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.Neptune.Types.DBClusterParameterGroupNameMessage" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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
  • 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 the DB cluster parameter group.

Constraints:

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

This value is stored as a lowercase string.