You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDS::ReservedDBInstance

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb

Defined Under Namespace

Classes: Collection

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ ReservedDBInstance #initialize(options = {}) ⇒ ReservedDBInstance

Returns a new instance of ReservedDBInstance

Overloads:



19
20
21
22
23
24
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 19

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)
end

Instance Method Details

#clientClient

Returns:



121
122
123
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 121

def client
  @client
end

#currency_codeString

The currency code for the reserved DB instance.

Returns:

  • (String)


72
73
74
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 72

def currency_code
  data[:currency_code]
end

#dataTypes::ReservedDBInstance



141
142
143
144
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 141

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.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



149
150
151
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 149

def data_loaded?
  !!@data
end

#db_instance_classString

The DB instance class for the reserved DB instance.

Returns:

  • (String)


42
43
44
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 42

def db_instance_class
  data[:db_instance_class]
end

#db_instance_countInteger

The number of reserved DB instances.

Returns:

  • (Integer)


78
79
80
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 78

def db_instance_count
  data[:db_instance_count]
end

#durationInteger

The duration of the reservation in seconds.

Returns:

  • (Integer)


54
55
56
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 54

def duration
  data[:duration]
end

#fixed_priceFloat

The fixed price charged for this reserved DB instance.

Returns:

  • (Float)


60
61
62
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 60

def fixed_price
  data[:fixed_price]
end

#idString Also known as: reserved_db_instance_id

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 29

def id
  @id
end

#loadself 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

Returns:

  • (self)


131
132
133
134
135
# File 'gems/aws-sdk-rds/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_azBoolean

Indicates if the reservation applies to Multi-AZ deployments.

Returns:

  • (Boolean)


96
97
98
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 96

def multi_az
  data[:multi_az]
end

#offeringReservedDBInstancesOffering?

Returns:



251
252
253
254
255
256
257
258
259
260
# File 'gems/aws-sdk-rds/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_typeString

The offering type of this reserved DB instance.

Returns:

  • (String)


90
91
92
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 90

def offering_type
  data[:offering_type]
end

#product_descriptionString

The description of the reserved DB instance.

Returns:

  • (String)


84
85
86
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 84

def product_description
  data[:product_description]
end

#recurring_chargesArray<Types::RecurringCharge>

The recurring price charged to run this reserved DB instance.

Returns:



108
109
110
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 108

def recurring_charges
  data[:recurring_charges]
end

#reserved_db_instance_arnString

The Amazon Resource Name (ARN) for the reserved DB instance.

Returns:

  • (String)


114
115
116
# File 'gems/aws-sdk-rds/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_idString

The offering identifier.

Returns:

  • (String)


36
37
38
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 36

def reserved_db_instances_offering_id
  data[:reserved_db_instances_offering_id]
end

#start_timeTime

The time the reservation started.

Returns:

  • (Time)


48
49
50
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 48

def start_time
  data[:start_time]
end

#stateString

The state of the reserved DB instance.

Returns:

  • (String)


102
103
104
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 102

def state
  data[:state]
end

#usage_priceFloat

The hourly price charged for this reserved DB instance.

Returns:

  • (Float)


66
67
68
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 66

def usage_price
  data[:usage_price]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

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(options) {|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

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (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.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instance.rb', line 231

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