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

Class: Aws::RDS::Types::ModifyOptionGroupMessage

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

Overview

Note:

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

{
  option_group_name: "String", # required
  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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediatelyBoolean

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

Returns:

  • (Boolean)


9508
9509
9510
9511
9512
9513
9514
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9508

class ModifyOptionGroupMessage < Struct.new(
  :option_group_name,
  :options_to_include,
  :options_to_remove,
  :apply_immediately)
  include Aws::Structure
end

#option_group_nameString

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

Returns:

  • (String)


9508
9509
9510
9511
9512
9513
9514
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9508

class ModifyOptionGroupMessage < Struct.new(
  :option_group_name,
  :options_to_include,
  :options_to_remove,
  :apply_immediately)
  include Aws::Structure
end

#options_to_includeArray<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.

Returns:



9508
9509
9510
9511
9512
9513
9514
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9508

class ModifyOptionGroupMessage < Struct.new(
  :option_group_name,
  :options_to_include,
  :options_to_remove,
  :apply_immediately)
  include Aws::Structure
end

#options_to_removeArray<String>

Options in this list are removed from the option group.

Returns:

  • (Array<String>)


9508
9509
9510
9511
9512
9513
9514
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9508

class ModifyOptionGroupMessage < Struct.new(
  :option_group_name,
  :options_to_include,
  :options_to_remove,
  :apply_immediately)
  include Aws::Structure
end