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

Description

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the /Parameter Groups/ option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Synopsis

Creating a Request

data ModifyDBParameterGroup Source #

See: newModifyDBParameterGroup smart constructor.

Constructors

ModifyDBParameterGroup' 

Fields

  • dbParameterGroupName :: Text

    The name of the DB parameter group.

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.
  • parameters :: [Parameter]

    An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

    Valid Values (for the application 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.

    When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.

Instances

Instances details
Eq ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

Read ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

Show ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

Generic ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

Associated Types

type Rep ModifyDBParameterGroup :: Type -> Type #

NFData ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

Methods

rnf :: ModifyDBParameterGroup -> () #

Hashable ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

AWSRequest ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

Associated Types

type AWSResponse ModifyDBParameterGroup #

ToHeaders ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

ToPath ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

ToQuery ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

type Rep ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

type Rep ModifyDBParameterGroup = D1 ('MetaData "ModifyDBParameterGroup" "Amazonka.RDS.ModifyDBParameterGroup" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "ModifyDBParameterGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Parameter])))
type AWSResponse ModifyDBParameterGroup Source # 
Instance details

Defined in Amazonka.RDS.ModifyDBParameterGroup

newModifyDBParameterGroup Source #

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

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

$sel:parameters:ModifyDBParameterGroup', modifyDBParameterGroup_parameters - An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

Valid Values (for the application 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.

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.

Request Lenses

modifyDBParameterGroup_dbParameterGroupName :: Lens' ModifyDBParameterGroup Text Source #

The name of the DB parameter group.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

modifyDBParameterGroup_parameters :: Lens' ModifyDBParameterGroup [Parameter] Source #

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

Valid Values (for the application 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.

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.

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

Read DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Show DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Generic DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Associated Types

type Rep DBParameterGroupNameMessage :: Type -> Type #

NFData DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

Hashable DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.DBParameterGroupNameMessage

FromXML DBParameterGroupNameMessage Source # 
Instance details

Defined in Amazonka.RDS.Types.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