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

Class: Aws::RDS::ReservedDBInstancesOffering

Inherits:
Aws::Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Aws::Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Aws::Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Aws::Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

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

Overloads:

  • #initialize(id, options = {}) ⇒ Object

    Parameters:

    • id (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :id (required, String)
    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#currency_codeString (readonly)

The currency code for the reserved DB instance offering.

Returns:

  • (String)

    The currency code for the reserved DB instance offering.

#db_instance_classString (readonly)

The DB instance class for the reserved DB instance.

Returns:

  • (String)

    The DB instance class for the reserved DB instance.

#durationInteger (readonly)

The duration of the offering in seconds.

Returns:

  • (Integer)

    The duration of the offering in seconds.

#fixed_priceFloat (readonly)

The fixed price charged for this offering.

Returns:

  • (Float)

    The fixed price charged for this offering.

#idString (readonly)

Returns:

  • (String)

#multi_azBoolean (readonly)

Indicates if the offering applies to Multi-AZ deployments.

Returns:

  • (Boolean)

    Indicates if the offering applies to Multi-AZ deployments.

#offering_typeString (readonly)

The offering type.

Returns:

  • (String)

    The offering type.

#product_descriptionString (readonly)

The database engine used by the offering.

Returns:

  • (String)

    The database engine used by the offering.

#recurring_chargesArray<Types::RecurringCharge> (readonly)

The recurring price charged to run this reserved DB instance.

Returns:

#reserved_db_instances_offering_idString (readonly)

The offering identifier.

Returns:

  • (String)

    The offering identifier.

#usage_priceFloat (readonly)

The hourly price charged for this offering.

Returns:

  • (Float)

    The hourly price charged for this offering.

Instance Method Details

#purchase(options = {}) ⇒ ReservedDBInstance

Examples:

Request syntax example with placeholder values


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

Basic usage

reserveddbinstance = reserveddbinstancesoffering.purchase(options)
reserveddbinstance.id
#=> "reserveddbinstance-id"

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:

See Also: