You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.
Class: Aws::RDS::DBSnapshotAttribute
- Inherits:
-
Object
- Object
- Aws::RDS::DBSnapshotAttribute
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb
Defined Under Namespace
Classes: Collection
Actions collapse
Read-Only Attributes collapse
-
#attribute_values ⇒ Array<String>
The value or values for the manual DB snapshot attribute.
-
#name ⇒ String
(also: #attribute_name)
-
#snapshot_id ⇒ String
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::DBSnapshotAttribute
Returns the data for this DBSnapshotAttribute.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ DBSnapshotAttribute
constructor
A new instance of DBSnapshotAttribute.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(snapshot_id, name, options = {}) ⇒ DBSnapshotAttribute #initialize(options = {}) ⇒ DBSnapshotAttribute
Returns a new instance of DBSnapshotAttribute
21 22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 21 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @snapshot_id = extract_snapshot_id(args, ) @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#attribute_values ⇒ Array<String>
The value or values for the manual DB snapshot attribute.
If the AttributeName
field is set to restore
, then this element
returns a list of IDs of the AWS accounts that are authorized to copy
or restore the manual DB snapshot. If a value of all
is in the list,
then the manual DB snapshot is public and available for any AWS
account to copy or restore.
51 52 53 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 51 def attribute_values data[:attribute_values] end |
#client ⇒ Client
58 59 60 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 58 def client @client end |
#data ⇒ Types::DBSnapshotAttribute
Returns the data for this Aws::RDS::DBSnapshotAttribute.
73 74 75 76 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 73 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.
81 82 83 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 81 def data_loaded? !!@data end |
#modify(options = {}) ⇒ Types::ModifyDBSnapshotAttributeResult
209 210 211 212 213 214 215 216 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 209 def modify( = {}) = .merge( attribute_name: @name, db_snapshot_identifier: @snapshot_id ) resp = @client.modify_db_snapshot_attribute() resp.data end |
#name ⇒ String Also known as: attribute_name
38 39 40 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 38 def name @name end |
#snapshot_id ⇒ String
33 34 35 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 33 def snapshot_id @snapshot_id 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
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot_attribute.rb', line 163 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 |