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

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", # required
  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, launch-template, natgateway, network-acl, network-interface, reserved-instances, route-table, security-group, snapshot, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway
      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)


506
507
508
509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 506

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

#availability_zoneString

The Availability Zone in which to allocate the Dedicated Host.

Returns:

  • (String)


506
507
508
509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 506

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :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)


506
507
508
509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 506

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :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)


506
507
508
509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 506

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

#instance_typeString

Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host.

Returns:

  • (String)


506
507
508
509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 506

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :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)


506
507
508
509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 506

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

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the Dedicated Host during creation.

Returns:



506
507
508
509
510
511
512
513
514
515
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 506

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