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

Inherits:

Struct

Object
Struct
Aws::EC2::Types::AllocateHostsRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#asset_ids ⇒ Array<String>

The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts.
#auto_placement ⇒ String

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.
#availability_zone ⇒ String

The Availability Zone in which to allocate the Dedicated Host.
#client_token ⇒ String

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

Indicates whether to enable or disable host maintenance for the Dedicated Host.
#host_recovery ⇒ String

Indicates whether to enable or disable host recovery for the Dedicated Host.
#instance_family ⇒ String

Specifies the instance family to be supported by the Dedicated Hosts.
#instance_type ⇒ String

Specifies the instance type to be supported by the Dedicated Hosts.
#outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
#quantity ⇒ Integer

The number of Dedicated Hosts to allocate to your account with these parameters.
#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the Dedicated Host during creation.

Instance Attribute Details

#asset_ids ⇒ `Array<String>`

The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.
If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

Returns:

(Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#auto_placement ⇒ `String`

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 auto-placement and affinity] in the *Amazon EC2 User Guide*.

Default: ‘off`

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ `String`

The Availability Zone in which to allocate the Dedicated Host.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#host_maintenance ⇒ `String`

Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see [Host maintenance] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#host_recovery ⇒ `String`

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 EC2 User Guide*.

Default: ‘off`

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#instance_family ⇒ `String`

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)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ `String`

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)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify AssetIds.

If you are allocating the Dedicated Host in a Region, omit this parameter.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#quantity ⇒ `Integer`

The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ `Array<Types::TagSpecification>`

The tags to apply to the Dedicated Host during creation.

Returns:

(Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 1081

class AllocateHostsRequest < Struct.new(
  :auto_placement,
  :availability_zone,
  :client_token,
  :instance_type,
  :instance_family,
  :quantity,
  :tag_specifications,
  :host_recovery,
  :outpost_arn,
  :host_maintenance,
  :asset_ids)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#asset_ids ⇒ Array<String>

#auto_placement ⇒ String

#availability_zone ⇒ String

#client_token ⇒ String

#host_maintenance ⇒ String

#host_recovery ⇒ String

#instance_family ⇒ String

#instance_type ⇒ String

#outpost_arn ⇒ String

#quantity ⇒ Integer

#tag_specifications ⇒ Array<Types::TagSpecification>

#asset_ids ⇒ `Array<String>`

#auto_placement ⇒ `String`

#availability_zone ⇒ `String`

#client_token ⇒ `String`

#host_maintenance ⇒ `String`

#host_recovery ⇒ `String`

#instance_family ⇒ `String`

#instance_type ⇒ `String`

#outpost_arn ⇒ `String`

#quantity ⇒ `Integer`

#tag_specifications ⇒ `Array<Types::TagSpecification>`