Class: Aws::RDS::Types::OptionGroupOption

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::OptionGroupOption

Defined in:

gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Available option.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #copyable_cross_account ⇒ Boolean

  Indicates whether the option can be copied across Amazon Web Services accounts.

• #default_port ⇒ Integer

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

• #description ⇒ String

  The description of the option.

• #engine_name ⇒ String

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

• #major_engine_version ⇒ String

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

• #minimum_required_minor_engine_version ⇒ String

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

• #name ⇒ String

  The name of the option.

• #option_group_option_settings ⇒ Array<Types::OptionGroupOptionSetting>

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

• #option_group_option_versions ⇒ Array<Types::OptionVersion>

  The versions that are available for the option.

• #options_conflicts_with ⇒ Array<String>

  The options that conflict with this option.

• #options_depended_on ⇒ Array<String>

  The options that are prerequisites for this option.

• #permanent ⇒ Boolean

  Permanent options can never be removed from an option group.

• #persistent ⇒ Boolean

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

• #port_required ⇒ Boolean

  Indicates whether the option requires a port.

• #requires_auto_minor_engine_version_upgrade ⇒ 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

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

• #vpc_only ⇒ Boolean

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

Instance Attribute Details

#copyable_cross_account ⇒ Boolean

Indicates whether the option can be copied across Amazon Web Services accounts.

Returns:

• (Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#default_port ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the option.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#engine_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#major_engine_version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_required_minor_engine_version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the option.

Returns:

• (String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_option_settings ⇒ Array<Types::OptionGroupOptionSetting>

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

Returns:

• (Array<Types::OptionGroupOptionSetting>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_option_versions ⇒ Array<Types::OptionVersion>

The versions that are available for the option.

Returns:

• (Array<Types::OptionVersion>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#options_conflicts_with ⇒ Array<String>

The options that conflict with this option.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#options_depended_on ⇒ Array<String>

The options that are prerequisites for this option.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#permanent ⇒ Boolean

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)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#persistent ⇒ Boolean

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)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#port_required ⇒ Boolean

Indicates whether the option requires a port.

Returns:

• (Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#requires_auto_minor_engine_version_upgrade ⇒ Boolean

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)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#supports_option_version_downgrade ⇒ Boolean

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)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_only ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20460

class OptionGroupOption < Struct.new(
  :name,
  :description,
  :engine_name,
  :major_engine_version,
  :minimum_required_minor_engine_version,
  :port_required,
  :default_port,
  :options_depended_on,
  :options_conflicts_with,
  :persistent,
  :permanent,
  :requires_auto_minor_engine_version_upgrade,
  :vpc_only,
  :supports_option_version_downgrade,
  :option_group_option_settings,
  :option_group_option_versions,
  :copyable_cross_account)
  SENSITIVE = []
  include Aws::Structure
end