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: ["DedicatedHostId"], # required
  limit_price: "String",
  offering_id: "OfferingId", # required
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Returns:

  • (String) —

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

#currency_code ⇒ String

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_set ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

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

    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_id ⇒ String

The ID of the offering.

Returns:

  • (String) —

    The ID of the offering.

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the Dedicated Host Reservation during purchase.

Returns: