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
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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) 


18368
18369
18370
18371
18372
18373
18374
18375
 
# File 'lib/aws-sdk-ec2/types.rb', line 18368

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

#currency_code ⇒ String

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

Returns:

  • (String) 


18368
18369
18370
18371
18372
18373
18374
18375
 
# File 'lib/aws-sdk-ec2/types.rb', line 18368

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

#host_id_set ⇒ Array<String>

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

Returns:

  • (Array<String>) 


18368
18369
18370
18371
18372
18373
18374
18375
 
# File 'lib/aws-sdk-ec2/types.rb', line 18368

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

#limit_price ⇒ 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). 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) 


18368
18369
18370
18371
18372
18373
18374
18375
 
# File 'lib/aws-sdk-ec2/types.rb', line 18368

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

#offering_id ⇒ String

The ID of the offering.

Returns:

  • (String) 


18368
18369
18370
18371
18372
18373
18374
18375
 
# File 'lib/aws-sdk-ec2/types.rb', line 18368

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