interface InstanceRequirementsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.CfnLaunchTemplate.InstanceRequirementsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnLaunchTemplate_InstanceRequirementsProperty`
Java	`software.amazon.awscdk.services.ec2.CfnLaunchTemplate.InstanceRequirementsProperty`
Python	`aws_cdk.aws_ec2.CfnLaunchTemplate.InstanceRequirementsProperty`
TypeScript	`aws-cdk-lib` » `aws_ec2` » `CfnLaunchTemplate` » `InstanceRequirementsProperty`

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 or AWS::EC2::Instance AWS CloudFormation resource, you can't specify InstanceRequirements .

For more information, see Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot placement score in the Amazon EC2 User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const instanceRequirementsProperty: ec2.CfnLaunchTemplate.InstanceRequirementsProperty = {
  acceleratorCount: {
    max: 123,
    min: 123,
  },
  acceleratorManufacturers: ['acceleratorManufacturers'],
  acceleratorNames: ['acceleratorNames'],
  acceleratorTotalMemoryMiB: {
    max: 123,
    min: 123,
  },
  acceleratorTypes: ['acceleratorTypes'],
  allowedInstanceTypes: ['allowedInstanceTypes'],
  bareMetal: 'bareMetal',
  baselineEbsBandwidthMbps: {
    max: 123,
    min: 123,
  },
  baselinePerformanceFactors: {
    cpu: {
      references: [{
        instanceFamily: 'instanceFamily',
      }],
    },
  },
  burstablePerformance: 'burstablePerformance',
  cpuManufacturers: ['cpuManufacturers'],
  excludedInstanceTypes: ['excludedInstanceTypes'],
  instanceGenerations: ['instanceGenerations'],
  localStorage: 'localStorage',
  localStorageTypes: ['localStorageTypes'],
  maxSpotPriceAsPercentageOfOptimalOnDemandPrice: 123,
  memoryGiBPerVCpu: {
    max: 123,
    min: 123,
  },
  memoryMiB: {
    max: 123,
    min: 123,
  },
  networkBandwidthGbps: {
    max: 123,
    min: 123,
  },
  networkInterfaceCount: {
    max: 123,
    min: 123,
  },
  onDemandMaxPricePercentageOverLowestPrice: 123,
  requireHibernateSupport: false,
  spotMaxPricePercentageOverLowestPrice: 123,
  totalLocalStorageGb: {
    max: 123,
    min: 123,
  },
  vCpuCount: {
    max: 123,
    min: 123,
  },
};

Properties

Name	Type	Description
acceleratorCount?	`IResolvable` `\|` `AcceleratorCountProperty`	The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
acceleratorManufacturers?	`string[]`	Indicates whether instance types must have accelerators by specific manufacturers.
acceleratorNames?	`string[]`	The accelerators that must be on the instance type.
acceleratorTotalMemoryMiB?	`IResolvable` `\|` `AcceleratorTotalMemoryMiBProperty`	The minimum and maximum amount of total accelerator memory, in MiB.
acceleratorTypes?	`string[]`	The accelerator types that must be on the instance type.
allowedInstanceTypes?	`string[]`	The instance types to apply your specified attributes against.
bareMetal?	`string`	Indicates whether bare metal instance types must be included, excluded, or required.
baselineEbsBandwidthMbps?	`IResolvable` `\|` `BaselineEbsBandwidthMbpsProperty`	The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.
baselinePerformanceFactors?	`IResolvable` `\|` `BaselinePerformanceFactorsProperty`	The baseline performance to consider, using an instance family as a baseline reference.
burstablePerformance?	`string`	Indicates whether burstable performance T instance types are included, excluded, or required.
cpuManufacturers?	`string[]`	The CPU manufacturers to include.
excludedInstanceTypes?	`string[]`	The instance types to exclude.
instanceGenerations?	`string[]`	Indicates whether current or previous generation instance types are included.
localStorage?	`string`	Indicates whether instance types with instance store volumes are included, excluded, or required.
localStorageTypes?	`string[]`	The type of local storage that is required.
maxSpotPriceAsPercentageOfOptimalOnDemandPrice?	`number`	[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price.
memoryGiBPerVCpu?	`IResolvable` `\|` `MemoryGiBPerVCpuProperty`	The minimum and maximum amount of memory per vCPU, in GiB.
memoryMiB?	`IResolvable` `\|` `MemoryMiBProperty`	The minimum and maximum amount of memory, in MiB.
networkBandwidthGbps?	`IResolvable` `\|` `NetworkBandwidthGbpsProperty`	The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
networkInterfaceCount?	`IResolvable` `\|` `NetworkInterfaceCountProperty`	The minimum and maximum number of network interfaces.
onDemandMaxPricePercentageOverLowestPrice?	`number`	[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price.
requireHibernateSupport?	`boolean \|` `IResolvable`	Indicates whether instance types must support hibernation for On-Demand Instances.
spotMaxPricePercentageOverLowestPrice?	`number`	[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.
totalLocalStorageGb?	`IResolvable` `\|` `TotalLocalStorageGBProperty`	The minimum and maximum amount of total local storage, in GB.
vCpuCount?	`IResolvable` `\|` `VCpuCountProperty`	The minimum and maximum number of vCPUs.

acceleratorCount?

Type: IResolvable | AcceleratorCountProperty (optional)

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.

To exclude accelerator-enabled instance types, set Max to 0 .

Default: No minimum or maximum limits

acceleratorManufacturers?

Type: string[] (optional)

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

acceleratorNames?

Type: string[] (optional)

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

acceleratorTotalMemoryMiB?

Type: IResolvable | AcceleratorTotalMemoryMiBProperty (optional)

The minimum and maximum amount of total accelerator memory, in MiB.

Default: No minimum or maximum limits

acceleratorTypes?

Type: string[] (optional)

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

allowedInstanceTypes?

Type: string[] (optional)

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 specify m5a.* , Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.

If you specify AllowedInstanceTypes , you can't specify ExcludedInstanceTypes .

Default: All instance types

bareMetal?

Type: string (optional)

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

baselineEbsBandwidthMbps?

Type: IResolvable | BaselineEbsBandwidthMbpsProperty (optional)

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

baselinePerformanceFactors?

Type: IResolvable | BaselinePerformanceFactorsProperty (optional)

The baseline performance to consider, using an instance family as a baseline reference.

The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the Amazon EC2 User Guide .

burstablePerformance?

Type: string (optional)

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

cpuManufacturers?

Type: string[] (optional)

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 .
For instance types with Apple CPUs, specify apple .

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?

Type: string[] (optional)

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 specify m5a.* , Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

If you specify ExcludedInstanceTypes , you can't specify AllowedInstanceTypes .

Default: No excluded instance types

instanceGenerations?

Type: string[] (optional)

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

localStorage?

Type: string (optional)

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

localStorageTypes?

Type: string[] (optional)

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 and ssd

maxSpotPriceAsPercentageOfOptimalOnDemandPrice?

Type: number (optional)

[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 to vcpu or memory-mib , the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.

Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice 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 as 999999 .

memoryGiBPerVCpu?

Type: IResolvable | MemoryGiBPerVCpuProperty (optional)

The minimum and maximum amount of memory per vCPU, in GiB.

Default: No minimum or maximum limits

memoryMiB?

Type: IResolvable | MemoryMiBProperty (optional)

The minimum and maximum amount of memory, in MiB.

networkBandwidthGbps?

Type: IResolvable | NetworkBandwidthGbpsProperty (optional)

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

Default: No minimum or maximum limits

networkInterfaceCount?

Type: IResolvable | NetworkInterfaceCountProperty (optional)

The minimum and maximum number of network interfaces.

Default: No minimum or maximum limits

onDemandMaxPricePercentageOverLowestPrice?

Type: number (optional)

[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 .

If you set TargetCapacityUnitType to vcpu or memory-mib , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.

Default: 20

requireHibernateSupport?

Type: boolean | IResolvable (optional)

Indicates whether instance types must support hibernation for On-Demand Instances.

This parameter is not supported for GetSpotPlacementScores .

Default: false

spotMaxPricePercentageOverLowestPrice?

Type: number (optional)

[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 to vcpu or memory-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 .

Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice 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 as 999999 .

Default: 100

totalLocalStorageGb?

Type: IResolvable | TotalLocalStorageGBProperty (optional)

The minimum and maximum amount of total local storage, in GB.

Default: No minimum or maximum limits

vCpuCount?

Type: IResolvable | VCpuCountProperty (optional)

The minimum and maximum number of vCPUs.