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

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

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

Overview

Available option.

Instance Attribute Summary collapse

Instance Attribute Details

#default_portInteger

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

Returns:

  • (Integer)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#descriptionString

The description of the option.

Returns:

  • (String)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#engine_nameString

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

Returns:

  • (String)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#major_engine_versionString

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

Returns:

  • (String)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#minimum_required_minor_engine_versionString

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

Returns:

  • (String)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#nameString

The name of the option.

Returns:

  • (String)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#option_group_option_settingsArray<Types::OptionGroupOptionSetting>

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



9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#option_group_option_versionsArray<Types::OptionVersion>

The versions that are available for the option.

Returns:



9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#options_conflicts_withArray<String>

The options that conflict with this option.

Returns:

  • (Array<String>)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#options_depended_onArray<String>

The options that are prerequisites for this option.

Returns:

  • (Array<String>)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#permanentBoolean

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)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#persistentBoolean

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)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end

#port_requiredBoolean

Specifies whether the option requires a port.

Returns:

  • (Boolean)


9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9634

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,
  :option_group_option_settings,
  :option_group_option_versions)
  include Aws::Structure
end