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: ["DedicatedHostId"], # required
  limit_price: "String",
  offering_id: "OfferingId", # required
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-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, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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

Returns:

  • (String)


53679
53680
53681
53682
53683
53684
53685
53686
53687
53688
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53679

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id,
  :tag_specifications)
  SENSITIVE = []
  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)


53679
53680
53681
53682
53683
53684
53685
53686
53687
53688
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53679

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#host_id_setArray<String>

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

Returns:

  • (Array<String>)


53679
53680
53681
53682
53683
53684
53685
53686
53687
53688
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53679

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id,
  :tag_specifications)
  SENSITIVE = []
  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)


53679
53680
53681
53682
53683
53684
53685
53686
53687
53688
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53679

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#offering_idString

The ID of the offering.

Returns:

  • (String)


53679
53680
53681
53682
53683
53684
53685
53686
53687
53688
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53679

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

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

Returns:



53679
53680
53681
53682
53683
53684
53685
53686
53687
53688
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 53679

class PurchaseHostReservationRequest < Struct.new(
  :client_token,
  :currency_code,
  :host_id_set,
  :limit_price,
  :offering_id,
  :tag_specifications)
  SENSITIVE = []
  include Aws::Structure
end