Class InstanceRequirements
- All Implemented Interfaces:
Serializable
,SdkPojo
,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 Creating an Auto Scaling 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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AcceleratorCountRequest
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.final List
<AcceleratorManufacturer> Indicates whether instance types must have accelerators by specific manufacturers.Indicates whether instance types must have accelerators by specific manufacturers.final List
<AcceleratorName> Lists the accelerators that must be on an instance type.Lists the accelerators that must be on an instance type.The minimum and maximum total memory size for the accelerators on an instance type, in MiB.final List
<AcceleratorType> Lists the accelerator types that must be on an instance type.Lists the accelerator types that must be on an instance type.The instance types to apply your specified attributes against.final BareMetal
Indicates whether bare metal instance types are included, excluded, or required.final String
Indicates whether bare metal instance types are included, excluded, or required.The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.static InstanceRequirements.Builder
builder()
final BurstablePerformance
Indicates whether burstable performance instance types are included, excluded, or required.final String
Indicates whether burstable performance instance types are included, excluded, or required.final List
<CpuManufacturer> Lists which specific CPU manufacturers to include.Lists which specific CPU manufacturers to include.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The instance types to exclude.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AcceleratorManufacturers property.final boolean
For responses, this returns true if the service returned a value for the AcceleratorNames property.final boolean
For responses, this returns true if the service returned a value for the AcceleratorTypes property.final boolean
For responses, this returns true if the service returned a value for the AllowedInstanceTypes property.final boolean
For responses, this returns true if the service returned a value for the CpuManufacturers property.final boolean
For responses, this returns true if the service returned a value for the ExcludedInstanceTypes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceGenerations property.final boolean
For responses, this returns true if the service returned a value for the LocalStorageTypes property.final List
<InstanceGeneration> Indicates whether current or previous generation instance types are included.Indicates whether current or previous generation instance types are included.final LocalStorage
Indicates whether instance types with instance store volumes are included, excluded, or required.final String
Indicates whether instance types with instance store volumes are included, excluded, or required.final List
<LocalStorageType> Indicates the type of local storage that is required.Indicates the type of local storage that is required.final Integer
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price.final MemoryGiBPerVCpuRequest
The minimum and maximum amount of memory per vCPU for an instance type, in GiB.final MemoryMiBRequest
The minimum and maximum instance memory size for an instance type, in MiB.The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).The minimum and maximum number of network interfaces for an instance type.final Integer
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price.final Boolean
Indicates whether instance types must provide On-Demand Instance hibernation support.static Class
<? extends InstanceRequirements.Builder> final Integer
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.The minimum and maximum total local storage size for an instance type, in GB.final VCpuCountRequest
The minimum and maximum number of vCPUs for an instance type.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 theisEmpty()
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
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
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 theisEmpty()
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
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 specifym5a.*
, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.If you specify
ExcludedInstanceTypes
, you can't specifyAllowedInstanceTypes
.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 specifym5a.*
, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.If you specify
ExcludedInstanceTypes
, you can't specifyAllowedInstanceTypes
.Default: No excluded instance types
-
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 theisEmpty()
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
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
[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
tovcpu
ormemory-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
orMaxSpotPriceAsPercentageOfOptimalOnDemandPrice
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 as999999
.- 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
tovcpu
ormemory-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
orMaxSpotPriceAsPercentageOfOptimalOnDemandPrice
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 as999999
.
-
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
tovcpu
ormemory-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
orMaxSpotPriceAsPercentageOfOptimalOnDemandPrice
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 as999999
.- 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
tovcpu
ormemory-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
orMaxSpotPriceAsPercentageOfOptimalOnDemandPrice
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 as999999
.
-
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
tovcpu
ormemory-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
tovcpu
ormemory-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
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 returnBareMetal.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombareMetalAsString()
.- Returns:
- Indicates whether bare metal instance types are included, excluded, or required.
Default:
excluded
- See Also:
-
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 returnBareMetal.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombareMetalAsString()
.- Returns:
- Indicates whether bare metal instance types are included, excluded, or required.
Default:
excluded
- See Also:
-
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 for Linux Instances.
Default:
excluded
If the service returns an enum value that is not available in the current SDK version,
burstablePerformance
will returnBurstablePerformance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromburstablePerformanceAsString()
.- 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:
-
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 returnBurstablePerformance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromburstablePerformanceAsString()
.- 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:
-
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
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
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 returnLocalStorage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocalStorageAsString()
.- 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:
-
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 returnLocalStorage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocalStorageAsString()
.- 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:
-
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 theisEmpty()
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
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
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
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
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 theisEmpty()
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
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
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
to0
.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
to0
.Default: No minimum or maximum limits
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
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
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 theisEmpty()
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
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 specifym5a.*
, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.If you specify
AllowedInstanceTypes
, you can't specifyExcludedInstanceTypes
.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 specifym5a.*
, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.If you specify
AllowedInstanceTypes
, you can't specifyExcludedInstanceTypes
.Default: All instance types
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<InstanceRequirements.Builder,
InstanceRequirements> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-