Class: Aws::RDS::DBParameterGroupFamily
- Inherits:
-
Object
- Object
- Aws::RDS::DBParameterGroupFamily
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
Associations collapse
-
#engine_default_cluster_parameters(options = {}) ⇒ Parameter::Collection
-
#engine_default_parameters(options = {}) ⇒ Parameter::Collection
Instance Method Summary collapse
-
#client ⇒ Client
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ DBParameterGroupFamily
constructor
A new instance of DBParameterGroupFamily.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ DBParameterGroupFamily #initialize(options = {}) ⇒ DBParameterGroupFamily
Returns a new instance of DBParameterGroupFamily.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = Aws::EmptyStructure.new @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#client ⇒ Client
40 41 42 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 40 def client @client 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.
61 62 63 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 61 def data_loaded? !!@data end |
#engine_default_cluster_parameters(options = {}) ⇒ Parameter::Collection
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 196 def engine_default_cluster_parameters( = {}) batches = Enumerator.new do |y| batch = [] = .merge(db_parameter_group_family: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.describe_engine_default_cluster_parameters() end resp.data.engine_defaults.parameters.each do |p| batch << Parameter.new( name: p.parameter_name, data: p, client: @client ) end y.yield(batch) end Parameter::Collection.new(batches) end |
#engine_default_parameters(options = {}) ⇒ Parameter::Collection
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 229 def engine_default_parameters( = {}) batches = Enumerator.new do |y| = .merge(db_parameter_group_family: @name) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.describe_engine_default_parameters() end resp.each_page do |page| batch = [] page.data.engine_defaults.parameters.each do |p| batch << Parameter.new( name: p.parameter_name, data: p, client: @client ) end y.yield(batch) end end Parameter::Collection.new(batches) end |
#name ⇒ String
33 34 35 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 33 def name @name end |
#wait_until(options = {}) {|resource| ... } ⇒ 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) do |instance|
instance.state.name == 'running'
end
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
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 145 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::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |