Package software.amazon.awscdk.services.ec2

Class InstanceRequirementsConfig.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.ec2.InstanceRequirementsConfig.Jsii$Proxy
All Implemented Interfaces:
InstanceRequirementsConfig, software.amazon.jsii.JsiiSerializable
Enclosing interface:
InstanceRequirementsConfig
@Stability(Stable) @Internal public static final class InstanceRequirementsConfig.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements InstanceRequirementsConfig
An implementation for InstanceRequirementsConfig

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(InstanceRequirementsConfig.Builder builder)
      Constructor that initializes the object based on literal property values passed by the InstanceRequirementsConfig.Builder.

  • Method Details

    • getMemoryMin

      public final Size getMemoryMin()
      Description copied from interface: InstanceRequirementsConfig
      The minimum instance memory size for an instance type, in MiB.

      Required: Yes

      Specified by:
      getMemoryMin in interface InstanceRequirementsConfig

    • getVCpuCountMin

      public final Number getVCpuCountMin()
      Description copied from interface: InstanceRequirementsConfig
      The minimum number of vCPUs for an instance type.

      Required: Yes

      Specified by:
      getVCpuCountMin in interface InstanceRequirementsConfig

    • getAcceleratorCountMax

      public final Number getAcceleratorCountMax()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getAcceleratorCountMax in interface InstanceRequirementsConfig

    • getAcceleratorCountMin

      public final Number getAcceleratorCountMin()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getAcceleratorCountMin in interface InstanceRequirementsConfig

    • getAcceleratorManufacturers

      public final List<AcceleratorManufacturer> getAcceleratorManufacturers()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getAcceleratorManufacturers in interface InstanceRequirementsConfig

    • getAcceleratorNames

      public final List<AcceleratorName> getAcceleratorNames()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getAcceleratorNames in interface InstanceRequirementsConfig

    • getAcceleratorTotalMemoryMax

      public final Size getAcceleratorTotalMemoryMax()
      Description copied from interface: InstanceRequirementsConfig
      The maximum total memory size for the accelerators on an instance type, in MiB.

      Default: - No minimum or maximum limits

      Specified by:
      getAcceleratorTotalMemoryMax in interface InstanceRequirementsConfig

    • getAcceleratorTotalMemoryMin

      public final Size getAcceleratorTotalMemoryMin()
      Description copied from interface: InstanceRequirementsConfig
      The minimum total memory size for the accelerators on an instance type, in MiB.

      Default: - No minimum or maximum limits

      Specified by:
      getAcceleratorTotalMemoryMin in interface InstanceRequirementsConfig

    • getAcceleratorTypes

      public final List<AcceleratorType> getAcceleratorTypes()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getAcceleratorTypes in interface InstanceRequirementsConfig

    • getAllowedInstanceTypes

      public final List<String> getAllowedInstanceTypes()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getAllowedInstanceTypes in interface InstanceRequirementsConfig

    • getBareMetal

      public final BareMetal getBareMetal()
      Description copied from interface: InstanceRequirementsConfig
      Indicates whether bare metal instance types are included, excluded, or required.

      Default: - excluded

      Specified by:
      getBareMetal in interface InstanceRequirementsConfig

    • getBaselineEbsBandwidthMbpsMax

      public final Number getBaselineEbsBandwidthMbpsMax()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getBaselineEbsBandwidthMbpsMax in interface InstanceRequirementsConfig

    • getBaselineEbsBandwidthMbpsMin

      public final Number getBaselineEbsBandwidthMbpsMin()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getBaselineEbsBandwidthMbpsMin in interface InstanceRequirementsConfig

    • getBurstablePerformance

      public final BurstablePerformance getBurstablePerformance()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getBurstablePerformance in interface InstanceRequirementsConfig

    • getCpuManufacturers

      public final List<CpuManufacturer> getCpuManufacturers()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getCpuManufacturers in interface InstanceRequirementsConfig

    • getExcludedInstanceTypes

      public final List<String> getExcludedInstanceTypes()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getExcludedInstanceTypes in interface InstanceRequirementsConfig

    • getInstanceGenerations

      public final List<InstanceGeneration> getInstanceGenerations()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getInstanceGenerations in interface InstanceRequirementsConfig

    • getLocalStorage

      public final LocalStorage getLocalStorage()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getLocalStorage in interface InstanceRequirementsConfig

    • getLocalStorageTypes

      public final List<LocalStorageType> getLocalStorageTypes()
      Description copied from interface: InstanceRequirementsConfig
      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

      Specified by:
      getLocalStorageTypes in interface InstanceRequirementsConfig

    • getMaxSpotPriceAsPercentageOfOptimalOnDemandPrice

      public final Number getMaxSpotPriceAsPercentageOfOptimalOnDemandPrice()
      Description copied from interface: InstanceRequirementsConfig
      [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

      Specified by:
      getMaxSpotPriceAsPercentageOfOptimalOnDemandPrice in interface InstanceRequirementsConfig

    • getMemoryMax

      public final Size getMemoryMax()
      Description copied from interface: InstanceRequirementsConfig
      The maximum instance memory size for an instance type, in MiB.

      Default: - No maximum limit

      Specified by:
      getMemoryMax in interface InstanceRequirementsConfig

    • getMemoryPerVCpuMax

      public final Size getMemoryPerVCpuMax()
      Description copied from interface: InstanceRequirementsConfig
      The maximum amount of memory per vCPU for an instance type, in GiB.

      Default: - No minimum or maximum limits

      Specified by:
      getMemoryPerVCpuMax in interface InstanceRequirementsConfig

    • getMemoryPerVCpuMin

      public final Size getMemoryPerVCpuMin()
      Description copied from interface: InstanceRequirementsConfig
      The minimum amount of memory per vCPU for an instance type, in GiB.

      Default: - No minimum or maximum limits

      Specified by:
      getMemoryPerVCpuMin in interface InstanceRequirementsConfig

    • getNetworkBandwidthGbpsMax

      public final Number getNetworkBandwidthGbpsMax()
      Description copied from interface: InstanceRequirementsConfig
      The maximum amount of network bandwidth, in gigabits per second (Gbps).

      Default: - No minimum or maximum limits

      Specified by:
      getNetworkBandwidthGbpsMax in interface InstanceRequirementsConfig

    • getNetworkBandwidthGbpsMin

      public final Number getNetworkBandwidthGbpsMin()
      Description copied from interface: InstanceRequirementsConfig
      The minimum amount of network bandwidth, in gigabits per second (Gbps).

      Default: - No minimum or maximum limits

      Specified by:
      getNetworkBandwidthGbpsMin in interface InstanceRequirementsConfig

    • getNetworkInterfaceCountMax

      public final Number getNetworkInterfaceCountMax()
      Description copied from interface: InstanceRequirementsConfig
      The maximum number of network interfaces for an instance type.

      Default: - No minimum or maximum limits

      Specified by:
      getNetworkInterfaceCountMax in interface InstanceRequirementsConfig

    • getNetworkInterfaceCountMin

      public final Number getNetworkInterfaceCountMin()
      Description copied from interface: InstanceRequirementsConfig
      The minimum number of network interfaces for an instance type.

      Default: - No minimum or maximum limits

      Specified by:
      getNetworkInterfaceCountMin in interface InstanceRequirementsConfig

    • getOnDemandMaxPricePercentageOverLowestPrice

      public final Number getOnDemandMaxPricePercentageOverLowestPrice()
      Description copied from interface: InstanceRequirementsConfig
      [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

      Specified by:
      getOnDemandMaxPricePercentageOverLowestPrice in interface InstanceRequirementsConfig

    • getRequireHibernateSupport

      public final Boolean getRequireHibernateSupport()
      Description copied from interface: InstanceRequirementsConfig
      Indicates whether instance types must provide On-Demand Instance hibernation support.

      Default: - false

      Specified by:
      getRequireHibernateSupport in interface InstanceRequirementsConfig

    • getSpotMaxPricePercentageOverLowestPrice

      public final Number getSpotMaxPricePercentageOverLowestPrice()
      Description copied from interface: InstanceRequirementsConfig
      [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

      Specified by:
      getSpotMaxPricePercentageOverLowestPrice in interface InstanceRequirementsConfig

    • getTotalLocalStorageGBMax

      public final Number getTotalLocalStorageGBMax()
      Description copied from interface: InstanceRequirementsConfig
      The maximum total local storage size for an instance type, in GB.

      Default: - No minimum or maximum limits

      Specified by:
      getTotalLocalStorageGBMax in interface InstanceRequirementsConfig

    • getTotalLocalStorageGBMin

      public final Number getTotalLocalStorageGBMin()
      Description copied from interface: InstanceRequirementsConfig
      The minimum total local storage size for an instance type, in GB.

      Default: - No minimum or maximum limits

      Specified by:
      getTotalLocalStorageGBMin in interface InstanceRequirementsConfig

    • getVCpuCountMax

      public final Number getVCpuCountMax()
      Description copied from interface: InstanceRequirementsConfig
      The maximum number of vCPUs for an instance type.

      Default: - No maximum limit

      Specified by:
      getVCpuCountMax in interface InstanceRequirementsConfig

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object