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
}

Contains the parameters for AllocateHosts.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_placementString

This is enabled by default. This property allows instances to be automatically placed onto available Dedicated Hosts, when you are launching instances without specifying a host ID.

Default: Enabled

Returns:

  • (String)


332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 332

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

#availability_zoneString

The Availability Zone for the Dedicated Hosts.

Returns:

  • (String)


332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 332

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

#client_tokenString

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.

Returns:

  • (String)


332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 332

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

#instance_typeString

Specify the instance type that you want your Dedicated Hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.

Returns:

  • (String)


332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 332

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

#quantityInteger

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

Returns:

  • (Integer)


332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 332

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