Package software.amazon.awscdk.services.ec2

Interface InstanceRequirementsConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
InstanceRequirementsConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-01T17:46:52.456Z") @Stability(Stable) public interface InstanceRequirementsConfig extends software.amazon.jsii.JsiiSerializable
The attributes for the instance types for a mixed instances policy.

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: You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

Example: 

 Vpc vpc;
 Role infrastructureRole;
 InstanceProfile instanceProfile;
 Cluster cluster = Cluster.Builder.create(this, "Cluster").vpc(vpc).build();
 // Create a Managed Instances Capacity Provider
 ManagedInstancesCapacityProvider miCapacityProvider = ManagedInstancesCapacityProvider.Builder.create(this, "MICapacityProvider")
         .infrastructureRole(infrastructureRole)
         .ec2InstanceProfile(instanceProfile)
         .subnets(vpc.getPrivateSubnets())
         .securityGroups(List.of(SecurityGroup.Builder.create(this, "MISecurityGroup").vpc(vpc).build()))
         .instanceRequirements(InstanceRequirementsConfig.builder()
                 .vCpuCountMin(1)
                 .memoryMin(Size.gibibytes(2))
                 .cpuManufacturers(List.of(CpuManufacturer.INTEL))
                 .acceleratorManufacturers(List.of(AcceleratorManufacturer.NVIDIA))
                 .build())
         .propagateTags(PropagateManagedInstancesTags.CAPACITY_PROVIDER)
         .build();
 // Add the capacity provider to the cluster
 cluster.addManagedInstancesCapacityProvider(miCapacityProvider);
 Ec2TaskDefinition taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
 taskDefinition.addContainer("web", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .memoryReservationMiB(256)
         .build());
 Ec2Service.Builder.create(this, "EC2Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .minHealthyPercent(100)
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider(miCapacityProvider.getCapacityProviderName())
                 .weight(1)
                 .build()))
         .build();

  • Method Details

    • getMemoryMin

      @Stability(Stable) @NotNull Size getMemoryMin()
      The minimum instance memory size for an instance type, in MiB.

      Required: Yes

    • getVCpuCountMin

      @Stability(Stable) @NotNull Number getVCpuCountMin()
      The minimum number of vCPUs for an instance type.

      Required: Yes

    • getAcceleratorCountMax

      @Stability(Stable) @Nullable default Number getAcceleratorCountMax()
      The maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.

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

      Default: - No minimum or maximum limits

    • getAcceleratorCountMin

      @Stability(Stable) @Nullable default Number getAcceleratorCountMin()
      The minimum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.

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

      Default: - No minimum or maximum limits

    • getAcceleratorManufacturers

      @Stability(Stable) @Nullable default List<AcceleratorManufacturer> getAcceleratorManufacturers()
      Indicates whether instance types must have accelerators by specific manufacturers.

      • For instance types with NVIDIA devices, specify nvidia.
      • For instance types with AMD devices, specify amd.
      • For instance types with AWS devices, specify amazon-web-services.
      • For instance types with Xilinx devices, specify xilinx.

      Default: - Any manufacturer

    • getAcceleratorNames

      @Stability(Stable) @Nullable default List<AcceleratorName> getAcceleratorNames()
      Lists the accelerators that must be on an instance type.

      • For instance types with NVIDIA A100 GPUs, specify a100.
      • For instance types with NVIDIA V100 GPUs, specify v100.
      • For instance types with NVIDIA K80 GPUs, specify k80.
      • For instance types with NVIDIA T4 GPUs, specify t4.
      • 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 Xilinx VU9P FPGAs, specify vu9p.

      Default: - Any accelerator

    • getAcceleratorTotalMemoryMax

      @Stability(Stable) @Nullable default Size getAcceleratorTotalMemoryMax()
      The maximum total memory size for the accelerators on an instance type, in MiB.

      Default: - No minimum or maximum limits

    • getAcceleratorTotalMemoryMin

      @Stability(Stable) @Nullable default Size getAcceleratorTotalMemoryMin()
      The minimum total memory size for the accelerators on an instance type, in MiB.

      Default: - No minimum or maximum limits

    • getAcceleratorTypes

      @Stability(Stable) @Nullable default List<AcceleratorType> getAcceleratorTypes()
      Lists the accelerator types that must be on an instance type.

      • For instance types with GPU accelerators, specify gpu.
      • For instance types with FPGA accelerators, specify fpga.
      • For instance types with inference accelerators, specify inference.

      Default: - Any accelerator type

    • getAllowedInstanceTypes

      @Stability(Stable) @Nullable default List<String> getAllowedInstanceTypes()
      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 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.

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

      Default: - All instance types

    • getBareMetal

      @Stability(Stable) @Nullable default BareMetal getBareMetal()
      Indicates whether bare metal instance types are included, excluded, or required.

      Default: - excluded

    • getBaselineEbsBandwidthMbpsMax

      @Stability(Stable) @Nullable default Number getBaselineEbsBandwidthMbpsMax()
      The maximum baseline bandwidth performance for an instance type, in Mbps.

      For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.

      Default: - No minimum or maximum limits

    • getBaselineEbsBandwidthMbpsMin

      @Stability(Stable) @Nullable default Number getBaselineEbsBandwidthMbpsMin()
      The minimum baseline bandwidth performance for an instance type, in Mbps.

      For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.

      Default: - No minimum or maximum limits

    • getBurstablePerformance

      @Stability(Stable) @Nullable default BurstablePerformance getBurstablePerformance()
      Indicates whether burstable performance instance types are included, excluded, or required.

      For more information, see Burstable performance instances in the Amazon EC2 User Guide.

      Default: - excluded

    • getCpuManufacturers

      @Stability(Stable) @Nullable default List<CpuManufacturer> getCpuManufacturers()
      Lists which specific 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.

      Note: Don't confuse the CPU hardware manufacturer with the CPU hardware 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

    • getExcludedInstanceTypes

      @Stability(Stable) @Nullable default List<String> getExcludedInstanceTypes()
      The instance types to exclude.

      You can use strings with one or more wild cards, represented by an asterisk (), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5., m5a., r*, 3.

      For example, if you specify c5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.

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

      Default: - No excluded instance types

    • getInstanceGenerations

      @Stability(Stable) @Nullable default List<InstanceGeneration> getInstanceGenerations()
      Indicates whether current or previous generation instance types are included.

      • For current generation instance types, specify current. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
      • For previous generation instance types, specify previous.

      Default: - Any current or previous generation

    • getLocalStorage

      @Stability(Stable) @Nullable default LocalStorage getLocalStorage()
      Indicates whether instance types with instance store volumes are included, excluded, or required.

      For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.

      Default: - included

    • getLocalStorageTypes

      @Stability(Stable) @Nullable default List<LocalStorageType> getLocalStorageTypes()
      Indicates 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: - Any local storage type

    • getMaxSpotPriceAsPercentageOfOptimalOnDemandPrice

      @Stability(Stable) @Nullable default Number getMaxSpotPriceAsPercentageOfOptimalOnDemandPrice()
      [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 either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

      The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

      If you set DesiredCapacityType 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.

      Note: Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 Auto Scaling 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: - Automatic optimal price protection

    • getMemoryMax

      @Stability(Stable) @Nullable default Size getMemoryMax()
      The maximum instance memory size for an instance type, in MiB.

      Default: - No maximum limit

    • getMemoryPerVCpuMax

      @Stability(Stable) @Nullable default Size getMemoryPerVCpuMax()
      The maximum amount of memory per vCPU for an instance type, in GiB.

      Default: - No minimum or maximum limits

    • getMemoryPerVCpuMin

      @Stability(Stable) @Nullable default Size getMemoryPerVCpuMin()
      The minimum amount of memory per vCPU for an instance type, in GiB.

      Default: - No minimum or maximum limits

    • getNetworkBandwidthGbpsMax

      @Stability(Stable) @Nullable default Number getNetworkBandwidthGbpsMax()
      The maximum amount of network bandwidth, in gigabits per second (Gbps).

      Default: - No minimum or maximum limits

    • getNetworkBandwidthGbpsMin

      @Stability(Stable) @Nullable default Number getNetworkBandwidthGbpsMin()
      The minimum amount of network bandwidth, in gigabits per second (Gbps).

      Default: - No minimum or maximum limits

    • getNetworkInterfaceCountMax

      @Stability(Stable) @Nullable default Number getNetworkInterfaceCountMax()
      The maximum number of network interfaces for an instance type.

      Default: - No minimum or maximum limits

    • getNetworkInterfaceCountMin

      @Stability(Stable) @Nullable default Number getNetworkInterfaceCountMin()
      The minimum number of network interfaces for an instance type.

      Default: - No minimum or maximum limits

    • getOnDemandMaxPricePercentageOverLowestPrice

      @Stability(Stable) @Nullable default Number getOnDemandMaxPricePercentageOverLowestPrice()
      [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. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

      The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

      To turn off price protection, specify a high value, such as 999999.

      If you set DesiredCapacityType 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

    • getRequireHibernateSupport

      @Stability(Stable) @Nullable default Boolean getRequireHibernateSupport()
      Indicates whether instance types must provide On-Demand Instance hibernation support.

      Default: - false

    • getSpotMaxPricePercentageOverLowestPrice

      @Stability(Stable) @Nullable default Number getSpotMaxPricePercentageOverLowestPrice()
      [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.

      The identified Spot 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 either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.

      The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

      If you set DesiredCapacityType 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.

      Note: Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 Auto Scaling 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: - Automatic optimal price protection

    • getTotalLocalStorageGBMax

      @Stability(Stable) @Nullable default Number getTotalLocalStorageGBMax()
      The maximum total local storage size for an instance type, in GB.

      Default: - No minimum or maximum limits

    • getTotalLocalStorageGBMin

      @Stability(Stable) @Nullable default Number getTotalLocalStorageGBMin()
      The minimum total local storage size for an instance type, in GB.

      Default: - No minimum or maximum limits

    • getVCpuCountMax

      @Stability(Stable) @Nullable default Number getVCpuCountMax()
      The maximum number of vCPUs for an instance type.

      Default: - No maximum limit

    • builder

      @Stability(Stable) static InstanceRequirementsConfig.Builder builder()
      Returns:
      a InstanceRequirementsConfig.Builder of InstanceRequirementsConfig