amazonka-redshift-2.0: Amazon Redshift 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.Redshift.ResetClusterParameterGroup

Description

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

Synopsis

Creating a Request

data ResetClusterParameterGroup Source #

See: newResetClusterParameterGroup smart constructor.

Constructors

ResetClusterParameterGroup' 

Fields

  • parameters :: Maybe [Parameter]

    An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

    Constraints: A maximum of 20 parameters can be reset in a single request.

  • resetAllParameters :: Maybe Bool

    If true, all parameters in the specified parameter group will be reset to their default values.

    Default: true

  • parameterGroupName :: Text

    The name of the cluster parameter group to be reset.

Instances

Instances details
ToHeaders ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

ToPath ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

ToQuery ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

AWSRequest ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

Generic ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

Associated Types

type Rep ResetClusterParameterGroup :: Type -> Type #

Read ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

Show ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

NFData ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

Eq ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

Hashable ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

type AWSResponse ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

type Rep ResetClusterParameterGroup Source # 
Instance details

Defined in Amazonka.Redshift.ResetClusterParameterGroup

type Rep ResetClusterParameterGroup = D1 ('MetaData "ResetClusterParameterGroup" "Amazonka.Redshift.ResetClusterParameterGroup" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "ResetClusterParameterGroup'" '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 "parameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newResetClusterParameterGroup Source #

Create a value of ResetClusterParameterGroup 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:

ResetClusterParameterGroup, resetClusterParameterGroup_parameters - An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

Constraints: A maximum of 20 parameters can be reset in a single request.

$sel:resetAllParameters:ResetClusterParameterGroup', resetClusterParameterGroup_resetAllParameters - If true, all parameters in the specified parameter group will be reset to their default values.

Default: true

ResetClusterParameterGroup, resetClusterParameterGroup_parameterGroupName - The name of the cluster parameter group to be reset.

Request Lenses

resetClusterParameterGroup_parameters :: Lens' ResetClusterParameterGroup (Maybe [Parameter]) Source #

An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

Constraints: A maximum of 20 parameters can be reset in a single request.

resetClusterParameterGroup_resetAllParameters :: Lens' ResetClusterParameterGroup (Maybe Bool) Source #

If true, all parameters in the specified parameter group will be reset to their default values.

Default: true

resetClusterParameterGroup_parameterGroupName :: Lens' ResetClusterParameterGroup Text Source #

The name of the cluster parameter group to be reset.

Destructuring the Response

data ClusterParameterGroupNameMessage Source #

See: newClusterParameterGroupNameMessage smart constructor.

Constructors

ClusterParameterGroupNameMessage' 

Fields

  • parameterGroupName :: Maybe Text

    The name of the cluster parameter group.

  • parameterGroupStatus :: Maybe Text

    The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

Instances

Instances details
FromXML ClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Redshift.Types.ClusterParameterGroupNameMessage

Generic ClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Redshift.Types.ClusterParameterGroupNameMessage

Associated Types

type Rep ClusterParameterGroupNameMessage :: Type -> Type #

Read ClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Redshift.Types.ClusterParameterGroupNameMessage

Show ClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Redshift.Types.ClusterParameterGroupNameMessage

NFData ClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Redshift.Types.ClusterParameterGroupNameMessage

Eq ClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Redshift.Types.ClusterParameterGroupNameMessage

Hashable ClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Redshift.Types.ClusterParameterGroupNameMessage

type Rep ClusterParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.Redshift.Types.ClusterParameterGroupNameMessage

type Rep ClusterParameterGroupNameMessage = D1 ('MetaData "ClusterParameterGroupNameMessage" "Amazonka.Redshift.Types.ClusterParameterGroupNameMessage" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "ClusterParameterGroupNameMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "parameterGroupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newClusterParameterGroupNameMessage :: ClusterParameterGroupNameMessage Source #

Create a value of ClusterParameterGroupNameMessage 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:parameterGroupName:ClusterParameterGroupNameMessage', clusterParameterGroupNameMessage_parameterGroupName - The name of the cluster parameter group.

$sel:parameterGroupStatus:ClusterParameterGroupNameMessage', clusterParameterGroupNameMessage_parameterGroupStatus - The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

Response Lenses

clusterParameterGroupNameMessage_parameterGroupStatus :: Lens' ClusterParameterGroupNameMessage (Maybe Text) Source #

The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.