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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_idsArray<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>)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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

Default: on

Returns:

  • (String)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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_zoneString

The Availability Zone in which to allocate the Dedicated Host.

Returns:

  • (String)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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_tokenString

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

Returns:

  • (String)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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_maintenanceString

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

Returns:

  • (String)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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

Default: off

Returns:

  • (String)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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_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)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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_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)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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_arnString

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)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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

#quantityInteger

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)


1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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_specificationsArray<Types::TagSpecification>

The tags to apply to the Dedicated Host during creation.

Returns:



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 1084

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