InstanceRequirements
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount
and MemoryMiB
. All other attributes
are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
-
AllowedInstanceTypes
- The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. -
ExcludedInstanceTypes
- The instance types to exclude from the list, even if they match your specified attributes.
Note
If you specify InstanceRequirements
, you can't specify
InstanceType
.
Attribute-based instance type selection is only supported when using Auto Scaling
groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in
the launch instance
wizard or with the RunInstances API, you
can't specify InstanceRequirements
.
For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide, and also Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
Contents
- AcceleratorCount (request), acceleratorCount (response)
-
The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set
Max
to0
.Default: No minimum or maximum limits
Type: AcceleratorCount object
Required: No
- AcceleratorManufacturers (request), acceleratorManufacturerSet (response)
-
Indicates whether instance types must have accelerators by specific manufacturers.
-
For instance types with AWS devices, specify
amazon-web-services
. -
For instance types with AMD devices, specify
amd
. -
For instance types with Habana devices, specify
habana
. -
For instance types with NVIDIA devices, specify
nvidia
. -
For instance types with Xilinx devices, specify
xilinx
.
Default: Any manufacturer
Type: Array of strings
Valid Values:
amazon-web-services | amd | nvidia | xilinx | habana
Required: No
-
- AcceleratorNames (request), acceleratorNameSet (response)
-
The accelerators that must be on the instance type.
-
For instance types with NVIDIA A10G GPUs, specify
a10g
. -
For instance types with NVIDIA A100 GPUs, specify
a100
. -
For instance types with NVIDIA H100 GPUs, specify
h100
. -
For instance types with AWS Inferentia chips, specify
inferentia
. -
For instance types with NVIDIA GRID K520 GPUs, specify
k520
. -
For instance types with NVIDIA K80 GPUs, specify
k80
. -
For instance types with NVIDIA M60 GPUs, specify
m60
. -
For instance types with AMD Radeon Pro V520 GPUs, specify
radeon-pro-v520
. -
For instance types with NVIDIA T4 GPUs, specify
t4
. -
For instance types with NVIDIA T4G GPUs, specify
t4g
. -
For instance types with Xilinx VU9P FPGAs, specify
vu9p
. -
For instance types with NVIDIA V100 GPUs, specify
v100
.
Default: Any accelerator
Type: Array of strings
Valid Values:
a100 | inferentia | k520 | k80 | m60 | radeon-pro-v520 | t4 | vu9p | v100 | a10g | h100 | t4g
Required: No
-
- AcceleratorTotalMemoryMiB (request), acceleratorTotalMemoryMiB (response)
-
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
Type: AcceleratorTotalMemoryMiB object
Required: No
- AcceleratorTypes (request), acceleratorTypeSet (response)
-
The accelerator types that must be on the instance type.
-
For instance types with GPU accelerators, specify
gpu
. -
For instance types with FPGA accelerators, specify
fpga
.
Default: Any accelerator type
Type: Array of strings
Valid Values:
gpu | fpga | inference
Required: No
-
- AllowedInstanceTypes (request), allowedInstanceTypeSet (response)
-
The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (
*
), to allow an instance type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.Note
If you specify
AllowedInstanceTypes
, you can't specifyExcludedInstanceTypes
.Default: All instance types
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 400 items.
Length Constraints: Minimum length of 1. Maximum length of 30.
Pattern:
[a-zA-Z0-9\.\*\-]+
Required: No
- BareMetal (request), bareMetal (response)
-
Indicates whether bare metal instance types must be included, excluded, or required.
-
To include bare metal instance types, specify
included
. -
To require only bare metal instance types, specify
required
. -
To exclude bare metal instance types, specify
excluded
.
Default:
excluded
Type: String
Valid Values:
included | required | excluded
Required: No
-
- BaselineEbsBandwidthMbps (request), baselineEbsBandwidthMbps (response)
-
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
Type: BaselineEbsBandwidthMbps object
Required: No
- BurstablePerformance (request), burstablePerformance (response)
-
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
-
To include burstable performance instance types, specify
included
. -
To require only burstable performance instance types, specify
required
. -
To exclude burstable performance instance types, specify
excluded
.
Default:
excluded
Type: String
Valid Values:
included | required | excluded
Required: No
-
- CpuManufacturers (request), cpuManufacturerSet (response)
-
The CPU manufacturers to include.
-
For instance types with Intel CPUs, specify
intel
. -
For instance types with AMD CPUs, specify
amd
. -
For instance types with AWS CPUs, specify
amazon-web-services
.
Note
Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
Type: Array of strings
Valid Values:
intel | amd | amazon-web-services
Required: No
-
- ExcludedInstanceTypes (request), excludedInstanceTypeSet (response)
-
The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (
*
), to exclude an instance type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.Note
If you specify
ExcludedInstanceTypes
, you can't specifyAllowedInstanceTypes
.Default: No excluded instance types
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 400 items.
Length Constraints: Minimum length of 1. Maximum length of 30.
Pattern:
[a-zA-Z0-9\.\*\-]+
Required: No
- InstanceGenerations (request), instanceGenerationSet (response)
-
Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify
current
.For previous generation instance types, specify
previous
.Default: Current and previous generation instance types
Type: Array of strings
Valid Values:
current | previous
Required: No
- LocalStorage (request), localStorage (response)
-
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
-
To include instance types with instance store volumes, specify
included
. -
To require only instance types with instance store volumes, specify
required
. -
To exclude instance types with instance store volumes, specify
excluded
.
Default:
included
Type: String
Valid Values:
included | required | excluded
Required: No
-
- LocalStorageTypes (request), localStorageTypeSet (response)
-
The type of local storage that is required.
-
For instance types with hard disk drive (HDD) storage, specify
hdd
. -
For instance types with solid state drive (SSD) storage, specify
ssd
.
Default:
hdd
andssd
Type: Array of strings
Valid Values:
hdd | ssd
Required: No
-
- MaxSpotPriceAsPercentageOfOptimalOnDemandPrice (request), maxSpotPriceAsPercentageOfOptimalOnDemandPrice (response)
-
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.Note
Only one of
SpotMaxPricePercentageOverLowestPrice
orMaxSpotPriceAsPercentageOfOptimalOnDemandPrice
can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as999999
.Type: Integer
Required: No
- MemoryGiBPerVCpu (request), memoryGiBPerVCpu (response)
-
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
Type: MemoryGiBPerVCpu object
Required: No
- MemoryMiB (request), memoryMiB (response)
-
The minimum and maximum amount of memory, in MiB.
Type: MemoryMiB object
Required: No
- NetworkBandwidthGbps (request), networkBandwidthGbps (response)
-
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
Type: NetworkBandwidthGbps object
Required: No
- NetworkInterfaceCount (request), networkInterfaceCount (response)
-
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
Type: NetworkInterfaceCount object
Required: No
- OnDemandMaxPricePercentageOverLowestPrice (request), onDemandMaxPricePercentageOverLowestPrice (response)
-
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999
.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Note
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.Default:
20
Type: Integer
Required: No
- RequireHibernateSupport (request), requireHibernateSupport (response)
-
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default:
false
Type: Boolean
Required: No
- SpotMaxPricePercentageOverLowestPrice (request), spotMaxPricePercentageOverLowestPrice (response)
-
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Note
Only one of
SpotMaxPricePercentageOverLowestPrice
orMaxSpotPriceAsPercentageOfOptimalOnDemandPrice
can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as999999
.Default:
100
Type: Integer
Required: No
- TotalLocalStorageGB (request), totalLocalStorageGB (response)
-
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
Type: TotalLocalStorageGB object
Required: No
- VCpuCount (request), vCpuCount (response)
-
The minimum and maximum number of vCPUs.
Type: VCpuCountRange object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: