AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
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 mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide, and also Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot placement score in the Amazon EC2 User Guide.
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
public class InstanceRequirements
The InstanceRequirements type exposes the following members
Name | Description | |
---|---|---|
InstanceRequirements() |
Name | Type | Description | |
---|---|---|---|
AcceleratorCount | Amazon.EC2.Model.AcceleratorCount |
Gets and sets the property AcceleratorCount. The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Default: No minimum or maximum limits |
|
AcceleratorManufacturers | System.Collections.Generic.List<System.String> |
Gets and sets the property AcceleratorManufacturers. Indicates whether instance types must have accelerators by specific manufacturers.
Default: Any manufacturer |
|
AcceleratorNames | System.Collections.Generic.List<System.String> |
Gets and sets the property AcceleratorNames. The accelerators that must be on the instance type.
Default: Any accelerator |
|
AcceleratorTotalMemoryMiB | Amazon.EC2.Model.AcceleratorTotalMemoryMiB |
Gets and sets the property AcceleratorTotalMemoryMiB. The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits |
|
AcceleratorTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property AcceleratorTypes. The accelerator types that must be on the instance type.
Default: Any accelerator type |
|
AllowedInstanceTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property AllowedInstanceTypes. 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 (
For example, if you specify
If you specify Default: All instance types |
|
BareMetal | Amazon.EC2.BareMetal |
Gets and sets the property BareMetal. Indicates whether bare metal instance types must be included, excluded, or required.
Default: |
|
BaselineEbsBandwidthMbps | Amazon.EC2.Model.BaselineEbsBandwidthMbps |
Gets and sets the property BaselineEbsBandwidthMbps. 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 |
|
BurstablePerformance | Amazon.EC2.BurstablePerformance |
Gets and sets the property BurstablePerformance. Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
Default: |
|
CpuManufacturers | System.Collections.Generic.List<System.String> |
Gets and sets the property CpuManufacturers. The CPU manufacturers to include.
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 |
|
ExcludedInstanceTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property ExcludedInstanceTypes. The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (
For example, if you specify
If you specify Default: No excluded instance types |
|
InstanceGenerations | System.Collections.Generic.List<System.String> |
Gets and sets the property InstanceGenerations. 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
For previous generation instance types, specify Default: Current and previous generation instance types |
|
LocalStorage | Amazon.EC2.LocalStorage |
Gets and sets the property LocalStorage. 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.
Default: |
|
LocalStorageTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property LocalStorageTypes. The type of local storage that is required.
Default: |
|
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice | System.Int32 |
Gets and sets the property MaxSpotPriceAsPercentageOfOptimalOnDemandPrice. [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
Only one of |
|
MemoryGiBPerVCpu | Amazon.EC2.Model.MemoryGiBPerVCpu |
Gets and sets the property MemoryGiBPerVCpu. The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits |
|
MemoryMiB | Amazon.EC2.Model.MemoryMiB |
Gets and sets the property MemoryMiB. The minimum and maximum amount of memory, in MiB. |
|
NetworkBandwidthGbps | Amazon.EC2.Model.NetworkBandwidthGbps |
Gets and sets the property NetworkBandwidthGbps. The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits |
|
NetworkInterfaceCount | Amazon.EC2.Model.NetworkInterfaceCount |
Gets and sets the property NetworkInterfaceCount. The minimum and maximum number of network interfaces. Default: No minimum or maximum limits |
|
OnDemandMaxPricePercentageOverLowestPrice | System.Int32 |
Gets and sets the property OnDemandMaxPricePercentageOverLowestPrice. [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 This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set
Default: |
|
RequireHibernateSupport | System.Boolean |
Gets and sets the property RequireHibernateSupport. Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores.
Default: |
|
SpotMaxPricePercentageOverLowestPrice | System.Int32 |
Gets and sets the property SpotMaxPricePercentageOverLowestPrice. [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 This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Only one of
Default: |
|
TotalLocalStorageGB | Amazon.EC2.Model.TotalLocalStorageGB |
Gets and sets the property TotalLocalStorageGB. The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits |
|
VCpuCount | Amazon.EC2.Model.VCpuCountRange |
Gets and sets the property VCpuCount. The minimum and maximum number of vCPUs. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5