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

Class: Aws::RDS::OptionGroupOption

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

#default_port ⇒ Integer (readonly)

If the option requires a port, specifies the default port for the option.

Returns:

  • (Integer) —

    If the option requires a port, specifies the default port for the option.

#description ⇒ String (readonly)

The description of the option.

Returns:

  • (String) —

    The description of the option.

#engine_name ⇒ String (readonly)

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

Returns:

  • (String) —

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

#major_engine_version ⇒ String (readonly)

Indicates the major engine version that the option is available for.

Returns:

  • (String) —

    Indicates the major engine version that the option is available for.

#minimum_required_minor_engine_version ⇒ String (readonly)

The minimum required engine version for the option to be applied.

Returns:

  • (String) —

    The minimum required engine version for the option to be applied.

#name ⇒ String (readonly)

Returns:

  • (String)

#option_group_option_settings ⇒ Array<Types::OptionGroupOptionSetting> (readonly)

The option settings that are available (and the default value) for each option in an option group.

Returns:

#option_group_option_versions ⇒ Array<Types::OptionVersion> (readonly)

The versions that are available for the option.

Returns:

#options_conflicts_with ⇒ Array<String> (readonly)

The options that conflict with this option.

Returns:

  • (Array<String>) —

    The options that conflict with this option.

#options_depended_on ⇒ Array<String> (readonly)

The options that are prerequisites for this option.

Returns:

  • (Array<String>) —

    The options that are prerequisites for this option.

#permanent ⇒ Boolean (readonly)

Permanent options can never be removed from an option group. An option group containing a permanent option can\'t be removed from a DB instance.

Returns:

  • (Boolean) —

    Permanent options can never be removed from an option group.

#persistent ⇒ Boolean (readonly)

Persistent options can\'t be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

Returns:

  • (Boolean) —

    Persistent options can\'t be removed from an option group while DB instances are associated with the option group.

#port_required ⇒ Boolean (readonly)

Specifies whether the option requires a port.

Returns:

  • (Boolean) —

    Specifies whether the option requires a port.

#requires_auto_minor_engine_version_upgrade ⇒ Boolean (readonly)

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

Returns:

  • (Boolean) —

    If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option.

#supports_option_version_downgrade ⇒ Boolean (readonly)

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

Returns:

  • (Boolean) —

    If true, you can change the option to an earlier version of the option.

#vpc_only ⇒ Boolean (readonly)

If true, you can only use this option with a DB instance that is in a VPC.

Returns:

  • (Boolean) —

    If true, you can only use this option with a DB instance that is in a VPC.