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

Class: Aws::RDS::OptionGroupOption

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ OptionGroupOption #initialize(options = {}) ⇒ OptionGroupOption

Returns a new instance of OptionGroupOption

Overloads:

  • #initialize(name, options = {}) ⇒ OptionGroupOption

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ OptionGroupOption

    Options Hash (options):

    • :name (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#clientClient

Returns:



115
116
117
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 115

def client
  @client
end

#dataTypes::OptionGroupOption

Returns the data for this Aws::RDS::OptionGroupOption.

Returns:

Raises:



130
131
132
133
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 130

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



138
139
140
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 138

def data_loaded?
  !!@data
end

#default_portInteger

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

Returns:

  • (Integer)


66
67
68
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 66

def default_port
  data.default_port
end

#descriptionString

The description of the option.

Returns:

  • (String)


35
36
37
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 35

def description
  data.description
end

#engine_nameString

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

Returns:

  • (String)


41
42
43
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 41

def engine_name
  data.engine_name
end

#major_engine_versionString

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

Returns:

  • (String)


47
48
49
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 47

def major_engine_version
  data.major_engine_version
end

#minimum_required_minor_engine_versionString

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

Returns:

  • (String)


53
54
55
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 53

def minimum_required_minor_engine_version
  data.minimum_required_minor_engine_version
end

#nameString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 29

def name
  @name
end

#option_group_option_settingsArray<Types::OptionGroupOptionSetting>

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



102
103
104
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 102

def option_group_option_settings
  data.option_group_option_settings
end

#option_group_option_versionsArray<Types::OptionVersion>

The versions that are available for the option.

Returns:



108
109
110
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 108

def option_group_option_versions
  data.option_group_option_versions
end

#options_conflicts_withArray<String>

The options that conflict with this option.

Returns:

  • (Array<String>)


78
79
80
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 78

def options_conflicts_with
  data.options_conflicts_with
end

#options_depended_onArray<String>

The options that are prerequisites for this option.

Returns:

  • (Array<String>)


72
73
74
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 72

def options_depended_on
  data.options_depended_on
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)


95
96
97
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 95

def permanent
  data.permanent
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)


87
88
89
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 87

def persistent
  data.persistent
end

#port_requiredBoolean

Specifies whether the option requires a port.

Returns:

  • (Boolean)


59
60
61
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 59

def port_required
  data.port_required
end