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

Class: Aws::RDS::DBClusterParameterGroup

Inherits:
Aws::Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Aws::Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Aws::Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Aws::Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(name, options = {}) ⇒ Object

    Parameters:

    • name (String)

    Options Hash (options):

    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :name (required, String)
    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#db_cluster_parameter_group_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) for the DB cluster parameter group.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the DB cluster parameter group.

#db_cluster_parameter_group_name ⇒ String (readonly)

The name of the DB cluster parameter group.

Returns:

  • (String) —

    The name of the DB cluster parameter group.

#db_parameter_group_family ⇒ String (readonly)

The name of the DB parameter group family that this DB cluster parameter group is compatible with.

Returns:

  • (String) —

    The name of the DB parameter group family that this DB cluster parameter group is compatible with.

#description ⇒ String (readonly)

Provides the customer-specified description for this DB cluster parameter group.

Returns:

  • (String) —

    Provides the customer-specified description for this DB cluster parameter group.

#name ⇒ String (readonly)

Returns:

  • (String)

Instance Method Details

#create(options = {}) ⇒ DBClusterParameterGroup

Examples:

Request syntax example with placeholder values


dbclusterparametergroup.create({
  db_parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Basic usage

dbclusterparametergroup = dbclusterparametergroup.create(options)
dbclusterparametergroup.name
#=> "dbclusterparametergroup-name"

Options Hash (options):

  • :db_parameter_group_family (required, String) —

    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

    Aurora MySQL

    Example: aurora5.6, aurora-mysql5.7

    Aurora PostgreSQL

    Example: aurora-postgresql9.6

  • :description (required, String) —

    The description for the DB cluster parameter group.

  • :tags (Array<Types::Tag>) —

    Tags to assign to the DB cluster parameter group.

Returns:

See Also:

#delete ⇒ Struct

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Examples:

Request syntax example with placeholder values


dbclusterparametergroup.delete()

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#modify(options = {}) ⇒ DBClusterParameterGroup

Examples:

Request syntax example with placeholder values


dbclusterparametergroup.modify({
  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"],
    },
  ],
})

Basic usage

dbclusterparametergroup = dbclusterparametergroup.modify(options)
dbclusterparametergroup.name
#=> "dbclusterparametergroup-name"

Options Hash (options):

  • :parameters (required, Array<Types::Parameter>) —

    A list of parameters in the DB cluster parameter group to modify.

Returns:

See Also:

#reset(options = {}) ⇒ DBClusterParameterGroup

Examples:

Request syntax example with placeholder values


dbclusterparametergroup.reset({
  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"],
    },
  ],
})

Basic usage

dbclusterparametergroup = dbclusterparametergroup.reset(options)
dbclusterparametergroup.name
#=> "dbclusterparametergroup-name"

Options Hash (options):

  • :reset_all_parameters (Boolean) —

    A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can\'t use this parameter if there is a list of parameter names specified for the Parameters parameter.

  • :parameters (Array<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 enabled.

Returns:

See Also: