Class InstanceRequirements
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InstanceRequirements.Builder,
InstanceRequirements>
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount
and MemoryMiB
. All other attributes are optional. Any
unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
-
AllowedInstanceTypes
- The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. -
ExcludedInstanceTypes
- The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements
, you can't specify InstanceType
.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet
to launch instances. If you plan to use the launch template in the launch instance wizard
or with the RunInstances
API, you can't specify InstanceRequirements
.
For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide, and also Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AcceleratorCount
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.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> The accelerators that must be on the instance type.The accelerators that must be on the instance type.The minimum and maximum amount of total accelerator memory, in MiB.final List
<AcceleratorType> The accelerator types that must be on the instance type.The accelerator types that must be on the instance type.The instance types to apply your specified attributes against.final BareMetal
Indicates whether bare metal instance types must be included, excluded, or required.final String
Indicates whether bare metal instance types must be included, excluded, or required.final BaselineEbsBandwidthMbps
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.static InstanceRequirements.Builder
builder()
final BurstablePerformance
Indicates whether burstable performance T instance types are included, excluded, or required.final String
Indicates whether burstable performance T instance types are included, excluded, or required.final List
<CpuManufacturer> The CPU manufacturers to include.The 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> The type of local storage that is required.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 MemoryGiBPerVCpu
The minimum and maximum amount of memory per vCPU, in GiB.final MemoryMiB
The minimum and maximum amount of memory, in MiB.final NetworkBandwidthGbps
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).final NetworkInterfaceCount
The minimum and maximum number of network interfaces.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 support hibernation for On-Demand Instances.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.final TotalLocalStorageGB
The minimum and maximum amount of total local storage, in GB.final VCpuCountRange
The minimum and maximum number of vCPUs.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
vCpuCount
The minimum and maximum number of vCPUs.
- Returns:
- The minimum and maximum number of vCPUs.
-
memoryMiB
The minimum and maximum amount of memory, in MiB.
- Returns:
- The minimum and maximum amount of memory, in MiB.
-
cpuManufacturers
The 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 manufacturer with the CPU 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:
- The 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 manufacturer with the CPU 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
The 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 manufacturer with the CPU 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:
- The 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 manufacturer with the CPU 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, in GiB.
Default: No minimum or maximum limits
- Returns:
- The minimum and maximum amount of memory per vCPU, 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 type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 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 type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 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. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify
current
.For previous generation instance types, specify
previous
.Default: Current and previous generation 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
hasInstanceGenerations()
method.- Returns:
- Indicates whether current or previous generation instance types are included. The current generation
instance types are recommended for use. Current generation instance types are typically the latest two to
three generations in each instance family. For more information, see Instance types in the
Amazon EC2 User Guide.
For current generation instance types, specify
current
.For previous generation instance types, specify
previous
.Default: Current and previous generation instance types
-
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. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify
current
.For previous generation instance types, specify
previous
.Default: Current and previous generation 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
hasInstanceGenerations()
method.- Returns:
- Indicates whether current or previous generation instance types are included. The current generation
instance types are recommended for use. Current generation instance types are typically the latest two to
three generations in each instance family. For more information, see Instance types in the
Amazon EC2 User Guide.
For current generation instance types, specify
current
.For previous generation instance types, specify
previous
.Default: Current and previous generation instance types
-
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 Spot 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 Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Only one of
SpotMaxPricePercentageOverLowestPrice
orMaxSpotPriceAsPercentageOfOptimalOnDemandPrice
can be specified. If you don't specify either, Amazon EC2 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
.Default:
100
- 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 Spot 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 Spot price is from the lowest priced current
generation instance types, and failing that, from the lowest priced previous generation instance types
that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude
instance types whose Spot price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Only one of
SpotMaxPricePercentageOverLowestPrice
orMaxSpotPriceAsPercentageOfOptimalOnDemandPrice
can be specified. If you don't specify either, Amazon EC2 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
.Default:
100
-
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. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999
.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set
TargetCapacityUnitType
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. When Amazon EC2 selects instance
types with your attributes, it will exclude instance types whose price exceeds your specified
threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999
.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set
TargetCapacityUnitType
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 must be included, excluded, or required.
-
To include bare metal instance types, specify
included
. -
To require only bare metal instance types, specify
required
. -
To exclude bare metal instance types, specify
excluded
.
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 must be included, excluded, or required.
-
To include bare metal instance types, specify
included
. -
To require only bare metal instance types, specify
required
. -
To exclude bare metal instance types, specify
excluded
.
Default:
excluded
-
- See Also:
-
-
bareMetalAsString
Indicates whether bare metal instance types must be included, excluded, or required.
-
To include bare metal instance types, specify
included
. -
To require only bare metal instance types, specify
required
. -
To exclude bare metal instance types, specify
excluded
.
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 must be included, excluded, or required.
-
To include bare metal instance types, specify
included
. -
To require only bare metal instance types, specify
required
. -
To exclude bare metal instance types, specify
excluded
.
Default:
excluded
-
- See Also:
-
-
burstablePerformance
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
-
To include burstable performance instance types, specify
included
. -
To require only burstable performance instance types, specify
required
. -
To exclude burstable performance instance types, specify
excluded
.
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 T instance types are included, excluded, or required. For more
information, see Burstable
performance instances.
-
To include burstable performance instance types, specify
included
. -
To require only burstable performance instance types, specify
required
. -
To exclude burstable performance instance types, specify
excluded
.
Default:
excluded
-
- See Also:
-
-
burstablePerformanceAsString
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
-
To include burstable performance instance types, specify
included
. -
To require only burstable performance instance types, specify
required
. -
To exclude burstable performance instance types, specify
excluded
.
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 T instance types are included, excluded, or required. For more
information, see Burstable
performance instances.
-
To include burstable performance instance types, specify
included
. -
To require only burstable performance instance types, specify
required
. -
To exclude burstable performance instance types, specify
excluded
.
Default:
excluded
-
- See Also:
-
-
requireHibernateSupport
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default:
false
- Returns:
- Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default:
false
-
networkInterfaceCount
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
- Returns:
- The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
-
localStorage
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
-
To include instance types with instance store volumes, specify
included
. -
To require only instance types with instance store volumes, specify
required
. -
To exclude instance types with instance store volumes, specify
excluded
.
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, Amazon EC2 instance
store in the Amazon EC2 User Guide.
-
To include instance types with instance store volumes, specify
included
. -
To require only instance types with instance store volumes, specify
required
. -
To exclude instance types with instance store volumes, specify
excluded
.
Default:
included
-
- See Also:
-
-
localStorageAsString
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
-
To include instance types with instance store volumes, specify
included
. -
To require only instance types with instance store volumes, specify
required
. -
To exclude instance types with instance store volumes, specify
excluded
.
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, Amazon EC2 instance
store in the Amazon EC2 User Guide.
-
To include instance types with instance store volumes, specify
included
. -
To require only instance types with instance store volumes, specify
required
. -
To exclude instance types with instance store volumes, specify
excluded
.
Default:
included
-
- See Also:
-
-
localStorageTypes
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:
hdd
andssd
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:
- 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:
hdd
andssd
-
-
-
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
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:
hdd
andssd
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:
- 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:
hdd
andssd
-
-
-
totalLocalStorageGB
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
- Returns:
- The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
-
baselineEbsBandwidthMbps
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
- Returns:
- The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized
instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
-
acceleratorTypes
The accelerator types that must be on the 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:
- The accelerator types that must be on the 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
The accelerator types that must be on the 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:
- The accelerator types that must be on the 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) on an instance.
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) on
an instance.
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 Amazon Web Services devices, specify
amazon-web-services
. -
For instance types with AMD devices, specify
amd
. -
For instance types with Habana devices, specify
habana
. -
For instance types with NVIDIA devices, specify
nvidia
. -
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 Amazon Web Services devices, specify
amazon-web-services
. -
For instance types with AMD devices, specify
amd
. -
For instance types with Habana devices, specify
habana
. -
For instance types with NVIDIA devices, specify
nvidia
. -
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 Amazon Web Services devices, specify
amazon-web-services
. -
For instance types with AMD devices, specify
amd
. -
For instance types with Habana devices, specify
habana
. -
For instance types with NVIDIA devices, specify
nvidia
. -
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 Amazon Web Services devices, specify
amazon-web-services
. -
For instance types with AMD devices, specify
amd
. -
For instance types with Habana devices, specify
habana
. -
For instance types with NVIDIA devices, specify
nvidia
. -
For instance types with Xilinx devices, specify
xilinx
.
Default: Any manufacturer
-
-
-
acceleratorNames
The accelerators that must be on the instance type.
-
For instance types with NVIDIA A10G GPUs, specify
a10g
. -
For instance types with NVIDIA A100 GPUs, specify
a100
. -
For instance types with NVIDIA H100 GPUs, specify
h100
. -
For instance types with Amazon Web Services Inferentia chips, specify
inferentia
. -
For instance types with NVIDIA GRID K520 GPUs, specify
k520
. -
For instance types with NVIDIA K80 GPUs, specify
k80
. -
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 NVIDIA T4 GPUs, specify
t4
. -
For instance types with NVIDIA T4G GPUs, specify
t4g
. -
For instance types with Xilinx VU9P FPGAs, specify
vu9p
. -
For instance types with NVIDIA V100 GPUs, specify
v100
.
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:
- The accelerators that must be on the instance type.
-
For instance types with NVIDIA A10G GPUs, specify
a10g
. -
For instance types with NVIDIA A100 GPUs, specify
a100
. -
For instance types with NVIDIA H100 GPUs, specify
h100
. -
For instance types with Amazon Web Services Inferentia chips, specify
inferentia
. -
For instance types with NVIDIA GRID K520 GPUs, specify
k520
. -
For instance types with NVIDIA K80 GPUs, specify
k80
. -
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 NVIDIA T4 GPUs, specify
t4
. -
For instance types with NVIDIA T4G GPUs, specify
t4g
. -
For instance types with Xilinx VU9P FPGAs, specify
vu9p
. -
For instance types with NVIDIA V100 GPUs, specify
v100
.
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
The accelerators that must be on the instance type.
-
For instance types with NVIDIA A10G GPUs, specify
a10g
. -
For instance types with NVIDIA A100 GPUs, specify
a100
. -
For instance types with NVIDIA H100 GPUs, specify
h100
. -
For instance types with Amazon Web Services Inferentia chips, specify
inferentia
. -
For instance types with NVIDIA GRID K520 GPUs, specify
k520
. -
For instance types with NVIDIA K80 GPUs, specify
k80
. -
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 NVIDIA T4 GPUs, specify
t4
. -
For instance types with NVIDIA T4G GPUs, specify
t4g
. -
For instance types with Xilinx VU9P FPGAs, specify
vu9p
. -
For instance types with NVIDIA V100 GPUs, specify
v100
.
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:
- The accelerators that must be on the instance type.
-
For instance types with NVIDIA A10G GPUs, specify
a10g
. -
For instance types with NVIDIA A100 GPUs, specify
a100
. -
For instance types with NVIDIA H100 GPUs, specify
h100
. -
For instance types with Amazon Web Services Inferentia chips, specify
inferentia
. -
For instance types with NVIDIA GRID K520 GPUs, specify
k520
. -
For instance types with NVIDIA K80 GPUs, specify
k80
. -
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 NVIDIA T4 GPUs, specify
t4
. -
For instance types with NVIDIA T4G GPUs, specify
t4g
. -
For instance types with Xilinx VU9P FPGAs, specify
vu9p
. -
For instance types with NVIDIA V100 GPUs, specify
v100
.
Default: Any accelerator
-
-
-
acceleratorTotalMemoryMiB
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
- Returns:
- The minimum and maximum amount of total accelerator memory, 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 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 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 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 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
-
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 the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 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 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 the lowest priced current generation instance
types, and failing that, from the lowest priced previous generation instance types that match your
attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types
whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 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 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
.
-
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
-