You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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"],
    },
  ],
}

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 apply method 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 9672

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

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

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent 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, and changes are applied when you reboot the DB instance without failover.