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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass PurchaseHostReservationRequest data as a 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*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html

Returns:

  • (String)


28292
28293
28294
28295
28296
28297
28298
28299
# File 'lib/aws-sdk-ec2/types.rb', line 28292

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id)
  include Aws::Structure
end

#currency_codeString

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

Returns:

  • (String)


28292
28293
28294
28295
28296
28297
28298
28299
# File 'lib/aws-sdk-ec2/types.rb', line 28292

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id)
  include Aws::Structure
end

#host_id_setArray<String>

The IDs of the Dedicated Hosts with which the reservation will be associated.

Returns:

  • (Array<String>)


28292
28293
28294
28295
28296
28297
28298
28299
# File 'lib/aws-sdk-ec2/types.rb', line 28292

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id)
  include Aws::Structure
end

#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 fails. 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)


28292
28293
28294
28295
28296
28297
28298
28299
# File 'lib/aws-sdk-ec2/types.rb', line 28292

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id)
  include Aws::Structure
end

#offering_idString

The ID of the offering.

Returns:

  • (String)


28292
28293
28294
28295
28296
28297
28298
28299
# File 'lib/aws-sdk-ec2/types.rb', line 28292

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id)
  include Aws::Structure
end