Class: Aws::RDS::Types::ModifyDBParameterGroupMessage

Inherits:

Struct

Object
Struct
Aws::RDS::Types::ModifyDBParameterGroupMessage

show all

Defined in:: gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass ModifyDBParameterGroupMessage data as a hash:

{
  db_parameter_group_name: "String", # required
  parameters: [ # required
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      apply_type: "String",
      data_type: "String",
      allowed_values: "String",
      is_modifiable: false,
      minimum_engine_version: "String",
      apply_method: "immediate", # accepts immediate, pending-reboot
      supported_engine_modes: ["String"],
    },
  ],
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#db_parameter_group_name ⇒ String
The name of the DB parameter group.
#parameters ⇒ Array<Types::Parameter>
An array of parameter names, values, and the application methods for the parameter update.

Instance Attribute Details

#db_parameter_group_name ⇒ `String`

The name of the DB parameter group.

Constraints:

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 16586

class ModifyDBParameterGroupMessage < Struct.new(
  :db_parameter_group_name,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ `Array<Types::Parameter>`

An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application 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.

You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.

For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.