class Aws::RDS::ReservedDBInstance
Public Class Methods
@overload def initialize(id, options = {})
@param [String] id @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :id @option options [Client] :client
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 22 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
@return [Client]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 137 def client @client end
The currency code for the reserved DB instance. @return [String]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 76 def currency_code data[:currency_code] end
@return [Types::ReservedDBInstance]
Returns the data for this {ReservedDBInstance}. Calls {Client#describe_reserved_db_instances} if {#data_loaded?} is `false`.
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 157 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 165 def data_loaded? !!@data end
The DB instance class for the reserved DB instance. @return [String]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 46 def db_instance_class data[:db_instance_class] end
The number of reserved DB instances. @return [Integer]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 82 def db_instance_count data[:db_instance_count] end
The duration of the reservation in seconds. @return [Integer]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 58 def duration data[:duration] end
The fixed price charged for this reserved DB instance. @return [Float]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 64 def fixed_price data[:fixed_price] end
@return [String]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 33 def id @id end
@deprecated @api private
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 282 def identifiers { id: @id } end
The unique identifier for the lease associated with the reserved DB instance.
<note markdown=“1”> Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
</note>
@return [String]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 130 def lease_id data[:lease_id] end
Loads, or reloads {#data} for the current {ReservedDBInstance}. Returns `self` making it possible to chain methods.
reserved_db_instance.reload.data
@return [self]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 147 def load resp = @client.describe_reserved_db_instances(reserved_db_instance_id: @id) @data = resp.reserved_db_instances[0] self end
Indicates if the reservation applies to Multi-AZ deployments. @return [Boolean]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 100 def multi_az data[:multi_az] end
@return [ReservedDBInstancesOffering, nil]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 269 def offering if data[:reserved_db_instances_offering_id] ReservedDBInstancesOffering.new( id: data[:reserved_db_instances_offering_id], client: @client ) else nil end end
The offering type of this reserved DB instance. @return [String]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 94 def offering_type data[:offering_type] end
The description of the reserved DB instance. @return [String]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 88 def product_description data[:product_description] end
The recurring price charged to run this reserved DB instance. @return [Array<Types::RecurringCharge>]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 112 def recurring_charges data[:recurring_charges] end
The Amazon Resource
Name (ARN) for the reserved DB instance. @return [String]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 118 def reserved_db_instance_arn data[:reserved_db_instance_arn] end
The offering identifier. @return [String]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 40 def reserved_db_instances_offering_id data[:reserved_db_instances_offering_id] end
The time the reservation started. @return [Time]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 52 def start_time data[:start_time] end
The state of the reserved DB instance. @return [String]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 106 def state data[:state] end
The hourly price charged for this reserved DB instance. @return [Float]
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 70 def usage_price data[:usage_price] end
@deprecated Use [Aws::RDS::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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(options) {|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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
terminates because the waiter has entered a state that it will not transition out of, preventing success. yet successful.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 249 def wait_until(options = {}, &block) self_copy = self.dup attempts = 0 options[:max_attempts] = 10 unless options.key?(:max_attempts) options[:delay] ||= 10 options[:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == options[:max_attempts] :retry end end Aws::Waiters::Waiter.new(options).wait({}) end
Private Instance Methods
# File lib/aws-sdk-rds/reserved_db_instance.rb, line 289 def extract_id(args, options) value = args[0] || options.delete(:id) case value when String then value when nil then raise ArgumentError, "missing required option :id" else msg = "expected :id to be a String, got #{value.class}" raise ArgumentError, msg end end