Class: Aws::RDS::ReservedDBInstancesOffering
- Inherits:
-
Object
- Object
- Aws::RDS::ReservedDBInstancesOffering
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/reserved_db_instances_offering.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#currency_code ⇒ String
The currency code for the reserved DB instance offering.
-
#db_instance_class ⇒ String
The DB instance class for the reserved DB instance.
-
#duration ⇒ Integer
The duration of the offering in seconds.
-
#fixed_price ⇒ Float
The fixed price charged for this offering.
- #id ⇒ String (also: #reserved_db_instances_offering_id)
-
#multi_az ⇒ Boolean
Indicates if the offering applies to Multi-AZ deployments.
-
#offering_type ⇒ String
The offering type.
-
#product_description ⇒ String
The database engine used by the offering.
-
#recurring_charges ⇒ Array<Types::RecurringCharge>
The recurring price charged to run this reserved DB instance.
-
#usage_price ⇒ Float
The hourly price charged for this offering.
Actions collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #purchase(options = {}) ⇒ ReservedDBInstance
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::ReservedDBInstancesOffering
Returns the data for this ReservedDBInstancesOffering.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ ReservedDBInstancesOffering
constructor
A new instance of ReservedDBInstancesOffering.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current ReservedDBInstancesOffering.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ ReservedDBInstancesOffering #initialize(options = {}) ⇒ ReservedDBInstancesOffering
Returns a new instance of ReservedDBInstancesOffering.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.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
91 92 93 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 91 def client @client end |
#currency_code ⇒ String
The currency code for the reserved DB instance offering.
60 61 62 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 60 def currency_code data[:currency_code] end |
#data ⇒ Types::ReservedDBInstancesOffering
Returns the data for this Aws::RDS::ReservedDBInstancesOffering. Calls Client#describe_reserved_db_instances_offerings if #data_loaded? is ‘false`.
111 112 113 114 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 111 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
119 120 121 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 119 def data_loaded? !!@data end |
#db_instance_class ⇒ String
The DB instance class for the reserved DB instance.
36 37 38 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 36 def db_instance_class data[:db_instance_class] end |
#duration ⇒ Integer
The duration of the offering in seconds.
42 43 44 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 42 def duration data[:duration] end |
#fixed_price ⇒ Float
The fixed price charged for this offering.
48 49 50 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 48 def fixed_price data[:fixed_price] end |
#id ⇒ String Also known as: reserved_db_instances_offering_id
29 30 31 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.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.
261 262 263 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 261 def identifiers { id: @id } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::ReservedDBInstancesOffering. Returns ‘self` making it possible to chain methods.
reserved_db_instances_offering.reload.data
101 102 103 104 105 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 101 def load resp = @client.describe_reserved_db_instances_offerings(reserved_db_instances_offering_id: @id) @data = resp.reserved_db_instances_offerings[0] self end |
#multi_az ⇒ Boolean
Indicates if the offering applies to Multi-AZ deployments.
78 79 80 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 78 def multi_az data[:multi_az] end |
#offering_type ⇒ String
The offering type.
72 73 74 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 72 def offering_type data[:offering_type] end |
#product_description ⇒ String
The database engine used by the offering.
66 67 68 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 66 def product_description data[:product_description] end |
#purchase(options = {}) ⇒ ReservedDBInstance
249 250 251 252 253 254 255 256 257 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 249 def purchase( = {}) = .merge(reserved_db_instances_offering_id: @id) resp = @client.purchase_reserved_db_instances_offering() ReservedDBInstance.new( id: resp.data.reserved_db_instance.reserved_db_instance_id, data: resp.data.reserved_db_instance, client: @client ) end |
#recurring_charges ⇒ Array<Types::RecurringCharge>
The recurring price charged to run this reserved DB instance.
84 85 86 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 84 def recurring_charges data[:recurring_charges] end |
#usage_price ⇒ Float
The hourly price charged for this offering.
54 55 56 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 54 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
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 201 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 |