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

Class: Aws::DocDB::Types::ResetDBClusterParameterGroupMessage

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

Overview

Note:

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

{
  db_cluster_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
    },
  ],
}

Represents the input to ResetDBClusterParameterGroup.

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_parameter_group_nameString

The name of the DB cluster parameter group to reset.

Returns:

  • (String)


4258
4259
4260
4261
4262
4263
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4258

class ResetDBClusterParameterGroupMessage < Struct.new(
  :db_cluster_parameter_group_name,
  :reset_all_parameters,
  :parameters)
  include Aws::Structure
end

#parametersArray<Types::Parameter>

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

Returns:



4258
4259
4260
4261
4262
4263
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4258

class ResetDBClusterParameterGroupMessage < Struct.new(
  :db_cluster_parameter_group_name,
  :reset_all_parameters,
  :parameters)
  include Aws::Structure
end

#reset_all_parametersBoolean

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

Returns:

  • (Boolean)


4258
4259
4260
4261
4262
4263
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4258

class ResetDBClusterParameterGroupMessage < Struct.new(
  :db_cluster_parameter_group_name,
  :reset_all_parameters,
  :parameters)
  include Aws::Structure
end