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

Class: Aws::RDS::ReservedDBInstancesOffering

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ReservedDBInstancesOffering

Overloads:



19
20
21
22
23
24
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instances_offering.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:



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

def client
  @client
end

#currency_codeString

The currency code for the reserved DB instance offering.

Returns:

  • (String)


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

def currency_code
  data[:currency_code]
end

#dataTypes::ReservedDBInstancesOffering



111
112
113
114
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 111

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.



119
120
121
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 119

def data_loaded?
  !!@data
end

#db_instance_classString

The DB instance class for the reserved DB instance.

Returns:

  • (String)


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

def db_instance_class
  data[:db_instance_class]
end

#durationInteger

The duration of the offering in seconds.

Returns:

  • (Integer)


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

def duration
  data[:duration]
end

#fixed_priceFloat

The fixed price charged for this offering.

Returns:

  • (Float)


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

def fixed_price
  data[:fixed_price]
end

#idString Also known as: reserved_db_instances_offering_id

Returns:

  • (String)


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

def id
  @id
end

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

Returns:

  • (self)


101
102
103
104
105
# File 'gems/aws-sdk-rds/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_azBoolean

Indicates if the offering applies to Multi-AZ deployments.

Returns:

  • (Boolean)


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

def multi_az
  data[:multi_az]
end

#offering_typeString

The offering type.

Returns:

  • (String)


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

def offering_type
  data[:offering_type]
end

#product_descriptionString

The database engine used by the offering.

Returns:

  • (String)


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

def product_description
  data[:product_description]
end

#purchase(options = {}) ⇒ ReservedDBInstance

Examples:

Request syntax with placeholder values


reserveddbinstance = reserved_db_instances_offering.purchase({
  reserved_db_instance_id: "String",
  db_instance_count: 1,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :reserved_db_instance_id (String)

    Customer-specified identifier to track this reservation.

    Example: myreservationID

  • :db_instance_count (Integer)

    The number of instances to reserve.

    Default: 1

  • :tags (Array<Types::Tag>)

    A list of tags. For more information, see Tagging Amazon RDS Resources.

Returns:



249
250
251
252
253
254
255
256
257
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 249

def purchase(options = {})
  options = options.merge(reserved_db_instances_offering_id: @id)
  resp = @client.purchase_reserved_db_instances_offering(options)
  ReservedDBInstance.new(
    id: resp.data.reserved_db_instance.reserved_db_instance_id,
    data: resp.data.reserved_db_instance,
    client: @client
  )
end

#recurring_chargesArray<Types::RecurringCharge>

The recurring price charged to run this reserved DB instance.

Returns:



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

def recurring_charges
  data[:recurring_charges]
end

#usage_priceFloat

The hourly price charged for this offering.

Returns:

  • (Float)


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

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/reserved_db_instances_offering.rb', line 201

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