Package software.amazon.awscdk.services.ec2

Class InstanceRequirementsConfig.Builder

java.lang.Object
software.amazon.awscdk.services.ec2.InstanceRequirementsConfig.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<InstanceRequirementsConfig>
Enclosing interface:
InstanceRequirementsConfig
@Stability(Stable) public static final class InstanceRequirementsConfig.Builder extends Object implements software.amazon.jsii.Builder<InstanceRequirementsConfig>
A builder for InstanceRequirementsConfig

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • memoryMin

      @Stability(Stable) public InstanceRequirementsConfig.Builder memoryMin(Size memoryMin)
      Sets the value of InstanceRequirementsConfig.getMemoryMin()
      Parameters:
      memoryMin - The minimum instance memory size for an instance type, in MiB. This parameter is required. Required: Yes
      Returns:
      this

    • vCpuCountMin

      @Stability(Stable) public InstanceRequirementsConfig.Builder vCpuCountMin(Number vCpuCountMin)
      Sets the value of InstanceRequirementsConfig.getVCpuCountMin()
      Parameters:
      vCpuCountMin - The minimum number of vCPUs for an instance type. This parameter is required. Required: Yes
      Returns:
      this

    • acceleratorCountMax

      @Stability(Stable) public InstanceRequirementsConfig.Builder acceleratorCountMax(Number acceleratorCountMax)
      Sets the value of InstanceRequirementsConfig.getAcceleratorCountMax()
      Parameters:
      acceleratorCountMax - 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.
      Returns:
      this

    • acceleratorCountMin

      @Stability(Stable) public InstanceRequirementsConfig.Builder acceleratorCountMin(Number acceleratorCountMin)
      Sets the value of InstanceRequirementsConfig.getAcceleratorCountMin()
      Parameters:
      acceleratorCountMin - 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.
      Returns:
      this

    • acceleratorManufacturers

      @Stability(Stable) public InstanceRequirementsConfig.Builder acceleratorManufacturers(List<? extends AcceleratorManufacturer> acceleratorManufacturers)
      Sets the value of InstanceRequirementsConfig.getAcceleratorManufacturers()
      Parameters:
      acceleratorManufacturers - 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.
      Returns:
      this

    • acceleratorNames

      @Stability(Stable) public InstanceRequirementsConfig.Builder acceleratorNames(List<? extends AcceleratorName> acceleratorNames)
      Sets the value of InstanceRequirementsConfig.getAcceleratorNames()
      Parameters:
      acceleratorNames - 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.
      Returns:
      this

    • acceleratorTotalMemoryMax

      @Stability(Stable) public InstanceRequirementsConfig.Builder acceleratorTotalMemoryMax(Size acceleratorTotalMemoryMax)
      Sets the value of InstanceRequirementsConfig.getAcceleratorTotalMemoryMax()
      Parameters:
      acceleratorTotalMemoryMax - The maximum total memory size for the accelerators on an instance type, in MiB.
      Returns:
      this

    • acceleratorTotalMemoryMin

      @Stability(Stable) public InstanceRequirementsConfig.Builder acceleratorTotalMemoryMin(Size acceleratorTotalMemoryMin)
      Sets the value of InstanceRequirementsConfig.getAcceleratorTotalMemoryMin()
      Parameters:
      acceleratorTotalMemoryMin - The minimum total memory size for the accelerators on an instance type, in MiB.
      Returns:
      this

    • acceleratorTypes

      @Stability(Stable) public InstanceRequirementsConfig.Builder acceleratorTypes(List<? extends AcceleratorType> acceleratorTypes)
      Sets the value of InstanceRequirementsConfig.getAcceleratorTypes()
      Parameters:
      acceleratorTypes - 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.
      Returns:
      this

    • allowedInstanceTypes

      @Stability(Stable) public InstanceRequirementsConfig.Builder allowedInstanceTypes(List<String> allowedInstanceTypes)
      Sets the value of InstanceRequirementsConfig.getAllowedInstanceTypes()
      Parameters:
      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 (), 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.

      Returns:
      this

    • bareMetal

      @Stability(Stable) public InstanceRequirementsConfig.Builder bareMetal(BareMetal bareMetal)
      Sets the value of InstanceRequirementsConfig.getBareMetal()
      Parameters:
      bareMetal - Indicates whether bare metal instance types are included, excluded, or required.
      Returns:
      this

    • baselineEbsBandwidthMbpsMax

      @Stability(Stable) public InstanceRequirementsConfig.Builder baselineEbsBandwidthMbpsMax(Number baselineEbsBandwidthMbpsMax)
      Sets the value of InstanceRequirementsConfig.getBaselineEbsBandwidthMbpsMax()
      Parameters:
      baselineEbsBandwidthMbpsMax - 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.
      Returns:
      this

    • baselineEbsBandwidthMbpsMin

      @Stability(Stable) public InstanceRequirementsConfig.Builder baselineEbsBandwidthMbpsMin(Number baselineEbsBandwidthMbpsMin)
      Sets the value of InstanceRequirementsConfig.getBaselineEbsBandwidthMbpsMin()
      Parameters:
      baselineEbsBandwidthMbpsMin - 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.
      Returns:
      this

    • burstablePerformance

      @Stability(Stable) public InstanceRequirementsConfig.Builder burstablePerformance(BurstablePerformance burstablePerformance)
      Sets the value of InstanceRequirementsConfig.getBurstablePerformance()
      Parameters:
      burstablePerformance - Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
      Returns:
      this

    • cpuManufacturers

      @Stability(Stable) public InstanceRequirementsConfig.Builder cpuManufacturers(List<? extends CpuManufacturer> cpuManufacturers)
      Sets the value of InstanceRequirementsConfig.getCpuManufacturers()
      Parameters:
      cpuManufacturers - 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.

      Returns:
      this

    • excludedInstanceTypes

      @Stability(Stable) public InstanceRequirementsConfig.Builder excludedInstanceTypes(List<String> excludedInstanceTypes)
      Sets the value of InstanceRequirementsConfig.getExcludedInstanceTypes()
      Parameters:
      excludedInstanceTypes - 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.

      Returns:
      this

    • instanceGenerations

      @Stability(Stable) public InstanceRequirementsConfig.Builder instanceGenerations(List<? extends InstanceGeneration> instanceGenerations)
      Sets the value of InstanceRequirementsConfig.getInstanceGenerations()
      Parameters:
      instanceGenerations - 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.
      Returns:
      this

    • localStorage

      @Stability(Stable) public InstanceRequirementsConfig.Builder localStorage(LocalStorage localStorage)
      Sets the value of InstanceRequirementsConfig.getLocalStorage()
      Parameters:
      localStorage - 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.
      Returns:
      this

    • localStorageTypes

      @Stability(Stable) public InstanceRequirementsConfig.Builder localStorageTypes(List<? extends LocalStorageType> localStorageTypes)
      Sets the value of InstanceRequirementsConfig.getLocalStorageTypes()
      Parameters:
      localStorageTypes - 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.
      Returns:
      this

    • maxSpotPriceAsPercentageOfOptimalOnDemandPrice

      @Stability(Stable) public InstanceRequirementsConfig.Builder maxSpotPriceAsPercentageOfOptimalOnDemandPrice(Number maxSpotPriceAsPercentageOfOptimalOnDemandPrice)
      Sets the value of InstanceRequirementsConfig.getMaxSpotPriceAsPercentageOfOptimalOnDemandPrice()
      Parameters:
      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 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.

      Returns:
      this

    • memoryMax

      @Stability(Stable) public InstanceRequirementsConfig.Builder memoryMax(Size memoryMax)
      Sets the value of InstanceRequirementsConfig.getMemoryMax()
      Parameters:
      memoryMax - The maximum instance memory size for an instance type, in MiB.
      Returns:
      this

    • memoryPerVCpuMax

      @Stability(Stable) public InstanceRequirementsConfig.Builder memoryPerVCpuMax(Size memoryPerVCpuMax)
      Sets the value of InstanceRequirementsConfig.getMemoryPerVCpuMax()
      Parameters:
      memoryPerVCpuMax - The maximum amount of memory per vCPU for an instance type, in GiB.
      Returns:
      this

    • memoryPerVCpuMin

      @Stability(Stable) public InstanceRequirementsConfig.Builder memoryPerVCpuMin(Size memoryPerVCpuMin)
      Sets the value of InstanceRequirementsConfig.getMemoryPerVCpuMin()
      Parameters:
      memoryPerVCpuMin - The minimum amount of memory per vCPU for an instance type, in GiB.
      Returns:
      this

    • networkBandwidthGbpsMax

      @Stability(Stable) public InstanceRequirementsConfig.Builder networkBandwidthGbpsMax(Number networkBandwidthGbpsMax)
      Sets the value of InstanceRequirementsConfig.getNetworkBandwidthGbpsMax()
      Parameters:
      networkBandwidthGbpsMax - The maximum amount of network bandwidth, in gigabits per second (Gbps).
      Returns:
      this

    • networkBandwidthGbpsMin

      @Stability(Stable) public InstanceRequirementsConfig.Builder networkBandwidthGbpsMin(Number networkBandwidthGbpsMin)
      Sets the value of InstanceRequirementsConfig.getNetworkBandwidthGbpsMin()
      Parameters:
      networkBandwidthGbpsMin - The minimum amount of network bandwidth, in gigabits per second (Gbps).
      Returns:
      this

    • networkInterfaceCountMax

      @Stability(Stable) public InstanceRequirementsConfig.Builder networkInterfaceCountMax(Number networkInterfaceCountMax)
      Sets the value of InstanceRequirementsConfig.getNetworkInterfaceCountMax()
      Parameters:
      networkInterfaceCountMax - The maximum number of network interfaces for an instance type.
      Returns:
      this

    • networkInterfaceCountMin

      @Stability(Stable) public InstanceRequirementsConfig.Builder networkInterfaceCountMin(Number networkInterfaceCountMin)
      Sets the value of InstanceRequirementsConfig.getNetworkInterfaceCountMin()
      Parameters:
      networkInterfaceCountMin - The minimum number of network interfaces for an instance type.
      Returns:
      this

    • onDemandMaxPricePercentageOverLowestPrice

      @Stability(Stable) public InstanceRequirementsConfig.Builder onDemandMaxPricePercentageOverLowestPrice(Number onDemandMaxPricePercentageOverLowestPrice)
      Sets the value of InstanceRequirementsConfig.getOnDemandMaxPricePercentageOverLowestPrice()
      Parameters:
      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. 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.

      Returns:
      this

    • requireHibernateSupport

      @Stability(Stable) public InstanceRequirementsConfig.Builder requireHibernateSupport(Boolean requireHibernateSupport)
      Sets the value of InstanceRequirementsConfig.getRequireHibernateSupport()
      Parameters:
      requireHibernateSupport - Indicates whether instance types must provide On-Demand Instance hibernation support.
      Returns:
      this

    • spotMaxPricePercentageOverLowestPrice

      @Stability(Stable) public InstanceRequirementsConfig.Builder spotMaxPricePercentageOverLowestPrice(Number spotMaxPricePercentageOverLowestPrice)
      Sets the value of InstanceRequirementsConfig.getSpotMaxPricePercentageOverLowestPrice()
      Parameters:
      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 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.

      Returns:
      this

    • totalLocalStorageGbMax

      @Stability(Stable) public InstanceRequirementsConfig.Builder totalLocalStorageGbMax(Number totalLocalStorageGbMax)
      Sets the value of
      invalid reference 
      InstanceRequirementsConfig#getTotalLocalStorageGbMax
      Parameters:
      totalLocalStorageGbMax - The maximum total local storage size for an instance type, in GB.
      Returns:
      this

    • totalLocalStorageGbMin

      @Stability(Stable) public InstanceRequirementsConfig.Builder totalLocalStorageGbMin(Number totalLocalStorageGbMin)
      Sets the value of
      invalid reference 
      InstanceRequirementsConfig#getTotalLocalStorageGbMin
      Parameters:
      totalLocalStorageGbMin - The minimum total local storage size for an instance type, in GB.
      Returns:
      this

    • vCpuCountMax

      @Stability(Stable) public InstanceRequirementsConfig.Builder vCpuCountMax(Number vCpuCountMax)
      Sets the value of InstanceRequirementsConfig.getVCpuCountMax()
      Parameters:
      vCpuCountMax - The maximum number of vCPUs for an instance type.
      Returns:
      this

    • build

      @Stability(Stable) public InstanceRequirementsConfig build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<InstanceRequirementsConfig>
      Returns:
      a new instance of InstanceRequirementsConfig
      Throws:
      NullPointerException - if any required attribute was not provided