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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/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.

Returns:

  • (String)


23436
23437
23438
23439
23440
23441
23442
23443
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23436

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)


23436
23437
23438
23439
23440
23441
23442
23443
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23436

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


23436
23437
23438
23439
23440
23441
23442
23443
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23436

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)


23436
23437
23438
23439
23440
23441
23442
23443
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23436

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)


23436
23437
23438
23439
23440
23441
23442
23443
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23436

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