Class: Aws::RDS::ReservedDBInstance
- Inherits:
-
Object
- Object
- Aws::RDS::ReservedDBInstance
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/reserved_db_instance.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#currency_code ⇒ String
The currency code for the reserved DB instance.
-
#db_instance_class ⇒ String
The DB instance class for the reserved DB instance.
-
#db_instance_count ⇒ Integer
The number of reserved DB instances.
-
#duration ⇒ Integer
The duration of the reservation in seconds.
-
#fixed_price ⇒ Float
The fixed price charged for this reserved DB instance.
- #id ⇒ String (also: #reserved_db_instance_id)
-
#multi_az ⇒ Boolean
Indicates if the reservation applies to Multi-AZ deployments.
-
#offering_type ⇒ String
The offering type of this reserved DB instance.
-
#product_description ⇒ String
The description of the reserved DB instance.
-
#recurring_charges ⇒ Array<Types::RecurringCharge>
The recurring price charged to run this reserved DB instance.
-
#reserved_db_instance_arn ⇒ String
The Amazon Resource Name (ARN) for the reserved DB instance.
-
#reserved_db_instances_offering_id ⇒ String
The offering identifier.
-
#start_time ⇒ Time
The time the reservation started.
-
#state ⇒ String
The state of the reserved DB instance.
-
#usage_price ⇒ Float
The hourly price charged for this reserved DB instance.
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #offering ⇒ ReservedDBInstancesOffering?
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::ReservedDBInstance
Returns the data for this ReservedDBInstance.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ ReservedDBInstance
constructor
A new instance of ReservedDBInstance.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current ReservedDBInstance.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ ReservedDBInstance #initialize(options = {}) ⇒ ReservedDBInstance
Returns a new instance of ReservedDBInstance.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#client ⇒ Client
121 122 123 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 121 def client @client end |
#currency_code ⇒ String
The currency code for the reserved DB instance.
72 73 74 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 72 def currency_code data[:currency_code] end |
#data ⇒ Types::ReservedDBInstance
Returns the data for this Aws::RDS::ReservedDBInstance. Calls Client#describe_reserved_db_instances if #data_loaded? is ‘false`.
141 142 143 144 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 141 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
149 150 151 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 149 def data_loaded? !!@data end |
#db_instance_class ⇒ String
The DB instance class for the reserved DB instance.
42 43 44 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 42 def db_instance_class data[:db_instance_class] end |
#db_instance_count ⇒ Integer
The number of reserved DB instances.
78 79 80 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 78 def db_instance_count data[:db_instance_count] end |
#duration ⇒ Integer
The duration of the reservation in seconds.
54 55 56 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 54 def duration data[:duration] end |
#fixed_price ⇒ Float
The fixed price charged for this reserved DB instance.
60 61 62 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 60 def fixed_price data[:fixed_price] end |
#id ⇒ String Also known as: reserved_db_instance_id
29 30 31 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 29 def id @id 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.
264 265 266 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 264 def identifiers { id: @id } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::ReservedDBInstance. Returns ‘self` making it possible to chain methods.
reserved_db_instance.reload.data
131 132 133 134 135 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 131 def load resp = @client.describe_reserved_db_instances(reserved_db_instance_id: @id) @data = resp.reserved_db_instances[0] self end |
#multi_az ⇒ Boolean
Indicates if the reservation applies to Multi-AZ deployments.
96 97 98 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 96 def multi_az data[:multi_az] end |
#offering ⇒ ReservedDBInstancesOffering?
251 252 253 254 255 256 257 258 259 260 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 251 def offering if data[:reserved_db_instances_offering_id] ReservedDBInstancesOffering.new( id: data[:reserved_db_instances_offering_id], client: @client ) else nil end end |
#offering_type ⇒ String
The offering type of this reserved DB instance.
90 91 92 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 90 def offering_type data[:offering_type] end |
#product_description ⇒ String
The description of the reserved DB instance.
84 85 86 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 84 def product_description data[:product_description] end |
#recurring_charges ⇒ Array<Types::RecurringCharge>
The recurring price charged to run this reserved DB instance.
108 109 110 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 108 def recurring_charges data[:recurring_charges] end |
#reserved_db_instance_arn ⇒ String
The Amazon Resource Name (ARN) for the reserved DB instance.
114 115 116 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 114 def reserved_db_instance_arn data[:reserved_db_instance_arn] end |
#reserved_db_instances_offering_id ⇒ String
The offering identifier.
36 37 38 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 36 def reserved_db_instances_offering_id data[:reserved_db_instances_offering_id] end |
#start_time ⇒ Time
The time the reservation started.
48 49 50 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 48 def start_time data[:start_time] end |
#state ⇒ String
The state of the reserved DB instance.
102 103 104 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 102 def state data[:state] end |
#usage_price ⇒ Float
The hourly price charged for this reserved DB instance.
66 67 68 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 66 def usage_price data[:usage_price] 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
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/aws-sdk-rds/reserved_db_instance.rb', line 231 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 |