Package software.amazon.awssdk.services.autoscaling.model

Class InstanceRequirements

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<InstanceRequirements.Builder,​InstanceRequirements>
    @Generated("software.amazon.awssdk:codegen")
public final class InstanceRequirements
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstanceRequirements.Builder,​InstanceRequirements>

    The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.

    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 Auto Scaling 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.

    You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

    For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see Preview instance types with specified attributes in the Amazon EC2 User Guide for Linux Instances.

    See Also:
    Serialized Form

    • Method Detail

      • vCpuCount

        public final VCpuCountRequest vCpuCount()

        The minimum and maximum number of vCPUs for an instance type.

        Returns:
        The minimum and maximum number of vCPUs for an instance type.

      • memoryMiB

        public final MemoryMiBRequest memoryMiB()

        The minimum and maximum instance memory size for an instance type, in MiB.

        Returns:
        The minimum and maximum instance memory size for an instance type, in MiB.

      • cpuManufacturers

        public final List<CpuManufacturer> 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 Amazon Web Services CPUs, specify amazon-web-services.

        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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCpuManufacturers() method.

        Returns:
        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 Amazon Web Services CPUs, specify amazon-web-services.

        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

      • hasCpuManufacturers

        public final boolean hasCpuManufacturers()
        For responses, this returns true if the service returned a value for the CpuManufacturers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • cpuManufacturersAsStrings

        public final List<String> cpuManufacturersAsStrings()

        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 Amazon Web Services CPUs, specify amazon-web-services.

        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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCpuManufacturers() method.

        Returns:
        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 Amazon Web Services CPUs, specify amazon-web-services.

        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

      • memoryGiBPerVCpu

        public final MemoryGiBPerVCpuRequest memoryGiBPerVCpu()

        The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

        Default: No minimum or maximum limits

        Returns:
        The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

        Default: No minimum or maximum limits

      • hasExcludedInstanceTypes

        public final boolean hasExcludedInstanceTypes()
        For responses, this returns true if the service returned a value for the ExcludedInstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • excludedInstanceTypes

        public final List<String> 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.

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

        Default: No excluded instance types

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludedInstanceTypes() method.

        Returns:
        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.

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

        Default: No excluded instance types

      • instanceGenerations

        public final List<InstanceGeneration> 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 Linux Instances.

        • For previous generation instance types, specify previous.

        Default: Any current or previous generation

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceGenerations() method.

        Returns:
        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 Linux Instances.

        • For previous generation instance types, specify previous.

        Default: Any current or previous generation

      • hasInstanceGenerations

        public final boolean hasInstanceGenerations()
        For responses, this returns true if the service returned a value for the InstanceGenerations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • instanceGenerationsAsStrings

        public final List<String> instanceGenerationsAsStrings()

        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 Linux Instances.

        • For previous generation instance types, specify previous.

        Default: Any current or previous generation

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceGenerations() method.

        Returns:
        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 Linux Instances.

        • For previous generation instance types, specify previous.

        Default: Any current or previous generation

      • spotMaxPricePercentageOverLowestPrice

        public final Integer 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.

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

        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.

      • maxSpotPriceAsPercentageOfOptimalOnDemandPrice

        public final Integer 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.

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

        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.

      • onDemandMaxPricePercentageOverLowestPrice

        public final Integer 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.

        Default: 20

        Returns:
        [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

      • bareMetal

        public final BareMetal bareMetal()

        Indicates whether bare metal instance types are included, excluded, or required.

        Default: excluded

        If the service returns an enum value that is not available in the current SDK version, bareMetal will return BareMetal.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bareMetalAsString().

        Returns:
        Indicates whether bare metal instance types are included, excluded, or required.

        Default: excluded

        See Also:
        BareMetal

      • bareMetalAsString

        public final String bareMetalAsString()

        Indicates whether bare metal instance types are included, excluded, or required.

        Default: excluded

        If the service returns an enum value that is not available in the current SDK version, bareMetal will return BareMetal.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bareMetalAsString().

        Returns:
        Indicates whether bare metal instance types are included, excluded, or required.

        Default: excluded

        See Also:
        BareMetal

      • burstablePerformanceAsString

        public final String burstablePerformanceAsString()

        Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.

        Default: excluded

        If the service returns an enum value that is not available in the current SDK version, burstablePerformance will return BurstablePerformance.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from burstablePerformanceAsString().

        Returns:
        Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.

        Default: excluded

        See Also:
        BurstablePerformance

      • requireHibernateSupport

        public final Boolean requireHibernateSupport()

        Indicates whether instance types must provide On-Demand Instance hibernation support.

        Default: false

        Returns:
        Indicates whether instance types must provide On-Demand Instance hibernation support.

        Default: false

      • networkInterfaceCount

        public final NetworkInterfaceCountRequest networkInterfaceCount()

        The minimum and maximum number of network interfaces for an instance type.

        Default: No minimum or maximum limits

        Returns:
        The minimum and maximum number of network interfaces for an instance type.

        Default: No minimum or maximum limits

      • localStorage

        public final LocalStorage 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 for Linux Instances.

        Default: included

        If the service returns an enum value that is not available in the current SDK version, localStorage will return LocalStorage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localStorageAsString().

        Returns:
        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 for Linux Instances.

        Default: included

        See Also:
        LocalStorage

      • localStorageAsString

        public final String localStorageAsString()

        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 for Linux Instances.

        Default: included

        If the service returns an enum value that is not available in the current SDK version, localStorage will return LocalStorage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localStorageAsString().

        Returns:
        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 for Linux Instances.

        Default: included

        See Also:
        LocalStorage

      • localStorageTypes

        public final List<LocalStorageType> 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.

        Default: Any local storage type

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLocalStorageTypes() method.

        Returns:
        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

      • hasLocalStorageTypes

        public final boolean hasLocalStorageTypes()
        For responses, this returns true if the service returned a value for the LocalStorageTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • localStorageTypesAsStrings

        public final List<String> localStorageTypesAsStrings()

        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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLocalStorageTypes() method.

        Returns:
        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

      • totalLocalStorageGB

        public final TotalLocalStorageGBRequest totalLocalStorageGB()

        The minimum and maximum total local storage size for an instance type, in GB.

        Default: No minimum or maximum limits

        Returns:
        The minimum and maximum total local storage size for an instance type, in GB.

        Default: No minimum or maximum limits

      • baselineEbsBandwidthMbps

        public final BaselineEbsBandwidthMbpsRequest baselineEbsBandwidthMbps()

        The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.

        Default: No minimum or maximum limits

        Returns:
        The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.

        Default: No minimum or maximum limits

      • acceleratorTypes

        public final List<AcceleratorType> 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.

        Default: Any accelerator type

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorTypes() method.

        Returns:
        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

      • hasAcceleratorTypes

        public final boolean hasAcceleratorTypes()
        For responses, this returns true if the service returned a value for the AcceleratorTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • acceleratorTypesAsStrings

        public final List<String> acceleratorTypesAsStrings()

        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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorTypes() method.

        Returns:
        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

      • acceleratorCount

        public final AcceleratorCountRequest acceleratorCount()

        The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.

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

        Default: No minimum or maximum limits

        Returns:
        The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.

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

        Default: No minimum or maximum limits

      • acceleratorManufacturers

        public final List<AcceleratorManufacturer> 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 Amazon Web Services devices, specify amazon-web-services.

        • For instance types with Xilinx devices, specify xilinx.

        Default: Any manufacturer

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorManufacturers() method.

        Returns:
        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 Amazon Web Services devices, specify amazon-web-services.

        • For instance types with Xilinx devices, specify xilinx.

        Default: Any manufacturer

      • hasAcceleratorManufacturers

        public final boolean hasAcceleratorManufacturers()
        For responses, this returns true if the service returned a value for the AcceleratorManufacturers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • acceleratorManufacturersAsStrings

        public final List<String> acceleratorManufacturersAsStrings()

        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 Amazon Web Services devices, specify amazon-web-services.

        • For instance types with Xilinx devices, specify xilinx.

        Default: Any manufacturer

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorManufacturers() method.

        Returns:
        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 Amazon Web Services devices, specify amazon-web-services.

        • For instance types with Xilinx devices, specify xilinx.

        Default: Any manufacturer

      • acceleratorNames

        public final List<AcceleratorName> 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.

        Default: Any accelerator

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorNames() method.

        Returns:
        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

      • hasAcceleratorNames

        public final boolean hasAcceleratorNames()
        For responses, this returns true if the service returned a value for the AcceleratorNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • acceleratorNamesAsStrings

        public final List<String> acceleratorNamesAsStrings()

        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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAcceleratorNames() method.

        Returns:
        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

      • acceleratorTotalMemoryMiB

        public final AcceleratorTotalMemoryMiBRequest acceleratorTotalMemoryMiB()

        The minimum and maximum total memory size for the accelerators on an instance type, in MiB.

        Default: No minimum or maximum limits

        Returns:
        The minimum and maximum total memory size for the accelerators on an instance type, in MiB.

        Default: No minimum or maximum limits

      • networkBandwidthGbps

        public final NetworkBandwidthGbpsRequest networkBandwidthGbps()

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

        Default: No minimum or maximum limits

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

        Default: No minimum or maximum limits

      • hasAllowedInstanceTypes

        public final boolean hasAllowedInstanceTypes()
        For responses, this returns true if the service returned a value for the AllowedInstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • allowedInstanceTypes

        public final List<String> 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.

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

        Default: All instance types

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedInstanceTypes() method.

        Returns:
        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.

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

        Default: All instance types

      • baselinePerformanceFactors

        public final BaselinePerformanceFactorsRequest baselinePerformanceFactors()

        The baseline performance factors for the instance requirements.

        Returns:
        The baseline performance factors for the instance requirements.

      • hashCode

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

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)