Class: Aws::RDS::DBEngine
- Inherits:
-
Object
- Object
- Aws::RDS::DBEngine
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/db_engine.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #option_group_options(options = {}) ⇒ OptionGroupOption::Collection
- #option_groups(options = {}) ⇒ OptionGroup::Collection
- #version(version) ⇒ DBEngineVersion
- #versions(options = {}) ⇒ DBEngineVersion::Collection
Instance Method Summary collapse
- #client ⇒ Client
- #data ⇒ EmptyStructure private
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ DBEngine
constructor
A new instance of DBEngine.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ DBEngine #initialize(options = {}) ⇒ DBEngine
Returns a new instance of DBEngine.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = Aws::EmptyStructure.new @client = .delete(:client) || Client.new() end |
Instance Method Details
#data ⇒ EmptyStructure
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.
50 51 52 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 50 def data @data end |
#data_loaded? ⇒ Boolean
57 58 59 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 57 def data_loaded? !!@data 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.
312 313 314 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 312 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.
42 43 44 45 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 42 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#name ⇒ String
29 30 31 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 29 def name @name end |
#option_group_options(options = {}) ⇒ OptionGroupOption::Collection
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 176 def ( = {}) batches = Enumerator.new do |y| = .merge(engine_name: @name) resp = @client.() resp.each_page do |page| batch = [] page.data..each do |o| batch << OptionGroupOption.new( name: o.name, data: o, client: @client ) end y.yield(batch) end end OptionGroupOption::Collection.new(batches) end |
#option_groups(options = {}) ⇒ OptionGroup::Collection
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 218 def option_groups( = {}) batches = Enumerator.new do |y| = .merge(engine_name: @name) resp = @client.describe_option_groups() resp.each_page do |page| batch = [] page.data.option_groups_list.each do |o| batch << OptionGroup.new( name: o.option_group_name, data: o, client: @client ) end y.yield(batch) end end OptionGroup::Collection.new(batches) end |
#version(version) ⇒ DBEngineVersion
239 240 241 242 243 244 245 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 239 def version(version) DBEngineVersion.new( engine_name: @name, version: version, client: @client ) end |
#versions(options = {}) ⇒ DBEngineVersion::Collection
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 290 def versions( = {}) batches = Enumerator.new do |y| = .merge(engine: @name) resp = @client.describe_db_engine_versions() resp.each_page do |page| batch = [] page.data.db_engine_versions.each do |d| batch << DBEngineVersion.new( engine_name: @name, version: d.engine_version, data: d, client: @client ) end y.yield(batch) end end DBEngineVersion::Collection.new(batches) 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
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/aws-sdk-rds/db_engine.rb', line 139 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 |