Class: Aws::RDS::OptionGroupOption
- Inherits:
-
Object
- Object
- Aws::RDS::OptionGroupOption
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/option_group_option.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#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
-
#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
Specifies 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 Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::OptionGroupOption
Returns the data for this OptionGroupOption.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
- #identifiers ⇒ Object deprecated private Deprecated.
-
#initialize(*args) ⇒ OptionGroupOption
constructor
A new instance of OptionGroupOption.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ OptionGroupOption #initialize(options = {}) ⇒ OptionGroupOption
Returns a new instance of OptionGroupOption.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#client ⇒ Client
139 140 141 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 139 def client @client end |
#data ⇒ Types::OptionGroupOption
Returns the data for this Aws::RDS::OptionGroupOption.
154 155 156 157 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 154 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
162 163 164 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 162 def data_loaded? !!@data end |
#default_port ⇒ Integer
If the option requires a port, specifies the default port for the option.
66 67 68 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 66 def default_port data[:default_port] end |
#description ⇒ String
The description of the option.
35 36 37 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 35 def description data[:description] end |
#engine_name ⇒ String
The name of the engine that this option can be applied to.
41 42 43 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 41 def engine_name data[:engine_name] end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
263 264 265 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 263 def identifiers { name: @name } end |
#load ⇒ Object Also known as: reload
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
145 146 147 148 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 145 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#major_engine_version ⇒ String
Indicates the major engine version that the option is available for.
47 48 49 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 47 def major_engine_version data[:major_engine_version] end |
#minimum_required_minor_engine_version ⇒ String
The minimum required engine version for the option to be applied.
53 54 55 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 53 def minimum_required_minor_engine_version data[:minimum_required_minor_engine_version] end |
#name ⇒ String
29 30 31 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 29 def name @name 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.
126 127 128 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 126 def option_group_option_settings data[:option_group_option_settings] end |
#option_group_option_versions ⇒ Array<Types::OptionVersion>
The versions that are available for the option.
132 133 134 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 132 def option_group_option_versions data[:option_group_option_versions] end |
#options_conflicts_with ⇒ Array<String>
The options that conflict with this option.
78 79 80 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 78 def data[:options_conflicts_with] end |
#options_depended_on ⇒ Array<String>
The options that are prerequisites for this option.
72 73 74 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 72 def data[:options_depended_on] 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.
95 96 97 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 95 def permanent data[:permanent] 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.
87 88 89 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 87 def persistent data[:persistent] end |
#port_required ⇒ Boolean
Specifies whether the option requires a port.
59 60 61 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 59 def port_required data[:port_required] 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.
104 105 106 |
# File '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_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.
119 120 121 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 119 def supports_option_version_downgrade data[:supports_option_version_downgrade] end |
#vpc_only ⇒ Boolean
If true, you can only use this option with a DB instance that is in a VPC.
111 112 113 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 111 def vpc_only data[:vpc_only] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::RDS::Client] #wait_until instead
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() {|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
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/aws-sdk-rds/option_group_option.rb', line 244 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |