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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_parameter_group_name ⇒ String

The name of the cluster parameter group to reset.

Returns:

  • (String) 


5481
5482
5483
5484
5485
5486
5487
 
# File 'lib/aws-sdk-docdb/types.rb', line 5481

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

#parameters ⇒ Array<Types::Parameter>

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

Returns:



5481
5482
5483
5484
5485
5486
5487
 
# File 'lib/aws-sdk-docdb/types.rb', line 5481

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

#reset_all_parameters ⇒ Boolean

A value that is set to `true` to reset all parameters in the 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) 


5481
5482
5483
5484
5485
5486
5487
 
# File 'lib/aws-sdk-docdb/types.rb', line 5481

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