Class: Aws::EC2::Types::AllocateHostsRequest

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 AllocateHostsRequest data as a hash:

{
  auto_placement: "on", # accepts on, off
  availability_zone: "String", # required
  client_token: "String",
  instance_type: "String",
  instance_family: "String",
  quantity: 1, # required
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, elastic-ip, fleet, fpga-image, host-reservation, image, instance, internet-gateway, key-pair, launch-template, 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",
        },
      ],
    },
  ],
  host_recovery: "on", # accepts on, off
}

Instance Attribute Summary collapse

Instance Attribute Details

#auto_placementString

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.

Default: on

Returns:

  • (String)


626
627
628
629
630
631
632
633
634
635
636
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 626

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery)
  include Aws::Structure
end

#availability_zoneString

The Availability Zone in which to allocate the Dedicated Host.

Returns:

  • (String)


626
627
628
629
630
631
632
633
634
635
636
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 626

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery)
  include Aws::Structure
end

#client_tokenString

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

Returns:

  • (String)


626
627
628
629
630
631
632
633
634
635
636
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 626

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery)
  include Aws::Structure
end

#host_recoveryString

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.

Default: off

Returns:

  • (String)


626
627
628
629
630
631
632
633
634
635
636
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 626

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery)
  include Aws::Structure
end

#instance_familyString

Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

Returns:

  • (String)


626
627
628
629
630
631
632
633
634
635
636
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 626

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery)
  include Aws::Structure
end

#instance_typeString

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

Returns:

  • (String)


626
627
628
629
630
631
632
633
634
635
636
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 626

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery)
  include Aws::Structure
end

#quantityInteger

The number of Dedicated Hosts to allocate to your account with these parameters.

Returns:

  • (Integer)


626
627
628
629
630
631
632
633
634
635
636
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 626

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery)
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the Dedicated Host during creation.

Returns:



626
627
628
629
630
631
632
633
634
635
636
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 626

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery)
  include Aws::Structure
end