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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ResetDBParameterGroupMessage as input to an Aws::Client method, you can use a vanilla 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
      supported_engine_modes: ["String"],
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#db_parameter_group_name ⇒ String

The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

^

Returns:

  • (String) —

    The name of the DB parameter group.

#parameters ⇒ Array<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:

  • (Array<Types::Parameter>) —

    To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters.

#reset_all_parameters ⇒ Boolean

A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

Returns:

  • (Boolean) —

    A value that indicates whether to reset all parameters in the DB parameter group to default values.