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

Class: Aws::RDS::Types::ResetDBParameterGroupMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

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

{
  db_parameter_group_name: "String", # required
  reset_all_parameters: false,
  parameters: [
    {
      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
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#db_parameter_group_nameString

The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

^

Returns:

  • (String)


10918
10919
10920
10921
10922
10923
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10918

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

#parametersArray<Types::Parameter>

To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

MySQL

Valid Values (for Apply 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 DB instance reboots.

MariaDB

Valid Values (for Apply 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 DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

Returns:



10918
10919
10920
10921
10922
10923
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10918

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

#reset_all_parametersBoolean

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

Returns:

  • (Boolean)


10918
10919
10920
10921
10922
10923
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 10918

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