Amazonka.DocumentDB.ResetDBClusterParameterGroup

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.

Creating a Request

data ResetDBClusterParameterGroup

Represents the input to ResetDBClusterParameterGroup.

See: newResetDBClusterParameterGroup smart constructor.

Constructors

ResetDBClusterParameterGroup'

Fields

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

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

• dbClusterParameterGroupName :: Text

  The name of the cluster parameter group to reset.

Instances

ToHeaders ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Methods

toHeaders :: ResetDBClusterParameterGroup -> [Header]

ToPath ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Methods

toPath :: ResetDBClusterParameterGroup -> ByteString

ToQuery ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Methods

toQuery :: ResetDBClusterParameterGroup -> QueryString

AWSRequest ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Associated Types

type AWSResponse ResetDBClusterParameterGroup

Methods

request :: (Service -> Service) -> ResetDBClusterParameterGroup -> Request ResetDBClusterParameterGroup

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

Generic ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Associated Types

type Rep ResetDBClusterParameterGroup :: Type -> Type

Methods

from :: ResetDBClusterParameterGroup -> Rep ResetDBClusterParameterGroup x

to :: Rep ResetDBClusterParameterGroup x -> ResetDBClusterParameterGroup

Read ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Methods

readsPrec :: Int -> ReadS ResetDBClusterParameterGroup

readList :: ReadS [ResetDBClusterParameterGroup]

readPrec :: ReadPrec ResetDBClusterParameterGroup

readListPrec :: ReadPrec [ResetDBClusterParameterGroup]

Show ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Methods

showsPrec :: Int -> ResetDBClusterParameterGroup -> ShowS

show :: ResetDBClusterParameterGroup -> String

showList :: [ResetDBClusterParameterGroup] -> ShowS

NFData ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Methods

rnf :: ResetDBClusterParameterGroup -> ()

Eq ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Methods

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

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

Hashable ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

Methods

hashWithSalt :: Int -> ResetDBClusterParameterGroup -> Int

hash :: ResetDBClusterParameterGroup -> Int

type AWSResponse ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

type AWSResponse ResetDBClusterParameterGroup = DBClusterParameterGroupNameMessage

type Rep ResetDBClusterParameterGroup

Defined in Amazonka.DocumentDB.ResetDBClusterParameterGroup

type Rep ResetDBClusterParameterGroup = D1 ('MetaData "ResetDBClusterParameterGroup" "Amazonka.DocumentDB.ResetDBClusterParameterGroup" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ResetDBClusterParameterGroup'" '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 "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newResetDBClusterParameterGroup

Arguments

:: Text

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:

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

ResetDBClusterParameterGroup, resetDBClusterParameterGroup_dbClusterParameterGroupName - The name of the cluster parameter group to reset.

Request Lenses

resetDBClusterParameterGroup_parameters :: Lens' ResetDBClusterParameterGroup (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.

resetDBClusterParameterGroup_resetAllParameters :: Lens' ResetDBClusterParameterGroup (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.

resetDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ResetDBClusterParameterGroup Text

The name of the cluster parameter group to reset.

Destructuring the Response

data DBClusterParameterGroupNameMessage

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

FromXML DBClusterParameterGroupNameMessage

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Methods

parseXML :: [Node] -> Either String DBClusterParameterGroupNameMessage

Generic DBClusterParameterGroupNameMessage

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Associated Types

type Rep DBClusterParameterGroupNameMessage :: Type -> Type

Methods

from :: DBClusterParameterGroupNameMessage -> Rep DBClusterParameterGroupNameMessage x

to :: Rep DBClusterParameterGroupNameMessage x -> DBClusterParameterGroupNameMessage

Read DBClusterParameterGroupNameMessage

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Methods

readsPrec :: Int -> ReadS DBClusterParameterGroupNameMessage

readList :: ReadS [DBClusterParameterGroupNameMessage]

readPrec :: ReadPrec DBClusterParameterGroupNameMessage

readListPrec :: ReadPrec [DBClusterParameterGroupNameMessage]

Show DBClusterParameterGroupNameMessage

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Methods

showsPrec :: Int -> DBClusterParameterGroupNameMessage -> ShowS

show :: DBClusterParameterGroupNameMessage -> String

showList :: [DBClusterParameterGroupNameMessage] -> ShowS

NFData DBClusterParameterGroupNameMessage

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Methods

rnf :: DBClusterParameterGroupNameMessage -> ()

Eq DBClusterParameterGroupNameMessage

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Methods

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

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

Hashable DBClusterParameterGroupNameMessage

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

Methods

hashWithSalt :: Int -> DBClusterParameterGroupNameMessage -> Int

hash :: DBClusterParameterGroupNameMessage -> Int

type Rep DBClusterParameterGroupNameMessage

Defined in Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage

type Rep DBClusterParameterGroupNameMessage = D1 ('MetaData "DBClusterParameterGroupNameMessage" "Amazonka.DocumentDB.Types.DBClusterParameterGroupNameMessage" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DBClusterParameterGroupNameMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage

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)

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.