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

Class: Aws::RDS::OptionGroup

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

#allows_vpc_and_non_vpc_instance_memberships ⇒ Boolean (readonly)

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

Returns:

  • (Boolean) —

    Indicates whether this option group can be applied to both VPC and non-VPC instances.

#engine_name ⇒ String (readonly)

Indicates the name of the engine that this option group can be applied to.

Returns:

  • (String) —

    Indicates the name of the engine that this option group can be applied to.

#major_engine_version ⇒ String (readonly)

Indicates the major engine version associated with this option group.

Returns:

  • (String) —

    Indicates the major engine version associated with this option group.

#name ⇒ String (readonly)

Returns:

  • (String)

#option_group_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) for the option group.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the option group.

#option_group_description ⇒ String (readonly)

Provides a description of the option group.

Returns:

  • (String) —

    Provides a description of the option group.

#option_group_name ⇒ String (readonly)

Specifies the name of the option group.

Returns:

  • (String) —

    Specifies the name of the option group.

#options ⇒ Array<Types::Option> (readonly)

Indicates what options are available in the option group.

Returns:

  • (Array<Types::Option>) —

    Indicates what options are available in the option group.

#vpc_id ⇒ String (readonly)

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

Returns:

  • (String) —

    If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.

Instance Method Details

#copy(options = {}) ⇒ OptionGroup

Examples:

Request syntax example with placeholder values


optiongroup.copy({
  target_option_group_identifier: "String", # required
  target_option_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Basic usage

optiongroup = optiongroup.copy(options)
optiongroup.name
#=> "optiongroup-name"

Options Hash (options):

  • :target_option_group_identifier (required, String) —

    The identifier for the copied option group.

    Constraints:

    • Can\'t be null, empty, or blank

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Can\'t end with a hyphen or contain two consecutive hyphens

    Example: my-option-group

  • :target_option_group_description (required, String) —

    The description for the copied option group.

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

    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Returns:

See Also:

#create(options = {}) ⇒ OptionGroup

Examples:

Request syntax example with placeholder values


optiongroup.create({
  engine_name: "String", # required
  major_engine_version: "String", # required
  option_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Basic usage

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

Options Hash (options):

  • :engine_name (required, String) —

    Specifies the name of the engine that this option group should be associated with.

  • :major_engine_version (required, String) —

    Specifies the major version of the engine that this option group should be associated with.

  • :option_group_description (required, String) —

    The description of the option group.

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

    Tags to assign to the option group.

Returns:

See Also:

#delete ⇒ Struct

Deletes an existing option group.

Examples:

Request syntax example with placeholder values


optiongroup.delete()

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#modify(options = {}) ⇒ OptionGroup

Examples:

Request syntax example with placeholder values


optiongroup.modify({
  options_to_include: [
    {
      option_name: "String", # required
      port: 1,
      option_version: "String",
      db_security_group_memberships: ["String"],
      vpc_security_group_memberships: ["String"],
      option_settings: [
        {
          name: "String",
          value: "String",
          default_value: "String",
          description: "String",
          apply_type: "String",
          data_type: "String",
          allowed_values: "String",
          is_modifiable: false,
          is_collection: false,
        },
      ],
    },
  ],
  options_to_remove: ["String"],
  apply_immediately: false,
})

Basic usage

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

Options Hash (options):

  • :options_to_include (Array<Types::OptionConfiguration>) —

    Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

  • :options_to_remove (Array<String>) —

    Options in this list are removed from the option group.

  • :apply_immediately (Boolean) —

    A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

Returns:

See Also: