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:



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

def client
  @client
end

#dataTypes::OptionGroupOption

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

Returns:

Raises:



154
155
156
157
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 154

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.



162
163
164
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 162

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.



126
127
128
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 126

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:



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

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

#requires_auto_minor_engine_version_upgradeBoolean

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)


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

def requires_auto_minor_engine_version_upgrade
  data[:requires_auto_minor_engine_version_upgrade]
end

#supports_option_version_downgradeBoolean

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)


119
120
121
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 119

def supports_option_version_downgrade
  data[:supports_option_version_downgrade]
end

#vpc_onlyBoolean

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

Returns:

  • (Boolean)


111
112
113
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 111

def vpc_only
  data[:vpc_only]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group_option.rb', line 244

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end