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

Class: Aws::EC2::Types::PurchaseHostReservationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PurchaseHostReservationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_token: "String",
  currency_code: "USD", # accepts USD
  host_id_set: ["String"], # required
  limit_price: "String",
  offering_id: "String", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)

    Unique, case-sensitive identifier you provide to ensure idempotency of the request.

#currency_codeString

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

Possible values:

  • USD

Returns:

  • (String)

    The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified.

#host_id_setArray<String>

The ID/s of the Dedicated Host/s that the reservation will be associated with.

Returns:

  • (Array<String>)

    The ID/s of the Dedicated Host/s that the reservation will be associated with.

#limit_priceString

The specified limit is checked against the total upfront cost of the reservation (calculated as the offering\'s upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request will fail. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

Returns:

  • (String)

    The specified limit is checked against the total upfront cost of the reservation (calculated as the offering\'s upfront cost multiplied by the host count).

#offering_idString

The ID of the offering.

Returns:

  • (String)

    The ID of the offering.