Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data InstanceRequirements = InstanceRequirements' {
- acceleratorCount :: Maybe AcceleratorCountRequest
- acceleratorManufacturers :: Maybe [AcceleratorManufacturer]
- acceleratorNames :: Maybe [AcceleratorName]
- acceleratorTotalMemoryMiB :: Maybe AcceleratorTotalMemoryMiBRequest
- acceleratorTypes :: Maybe [AcceleratorType]
- allowedInstanceTypes :: Maybe [Text]
- bareMetal :: Maybe BareMetal
- baselineEbsBandwidthMbps :: Maybe BaselineEbsBandwidthMbpsRequest
- burstablePerformance :: Maybe BurstablePerformance
- cpuManufacturers :: Maybe [CpuManufacturer]
- excludedInstanceTypes :: Maybe [Text]
- instanceGenerations :: Maybe [InstanceGeneration]
- localStorage :: Maybe LocalStorage
- localStorageTypes :: Maybe [LocalStorageType]
- memoryGiBPerVCpu :: Maybe MemoryGiBPerVCpuRequest
- networkBandwidthGbps :: Maybe NetworkBandwidthGbpsRequest
- networkInterfaceCount :: Maybe NetworkInterfaceCountRequest
- onDemandMaxPricePercentageOverLowestPrice :: Maybe Natural
- requireHibernateSupport :: Maybe Bool
- spotMaxPricePercentageOverLowestPrice :: Maybe Natural
- totalLocalStorageGB :: Maybe TotalLocalStorageGBRequest
- vCpuCount :: VCpuCountRequest
- memoryMiB :: MemoryMiBRequest
- newInstanceRequirements :: VCpuCountRequest -> MemoryMiBRequest -> InstanceRequirements
- instanceRequirements_acceleratorCount :: Lens' InstanceRequirements (Maybe AcceleratorCountRequest)
- instanceRequirements_acceleratorManufacturers :: Lens' InstanceRequirements (Maybe [AcceleratorManufacturer])
- instanceRequirements_acceleratorNames :: Lens' InstanceRequirements (Maybe [AcceleratorName])
- instanceRequirements_acceleratorTotalMemoryMiB :: Lens' InstanceRequirements (Maybe AcceleratorTotalMemoryMiBRequest)
- instanceRequirements_acceleratorTypes :: Lens' InstanceRequirements (Maybe [AcceleratorType])
- instanceRequirements_allowedInstanceTypes :: Lens' InstanceRequirements (Maybe [Text])
- instanceRequirements_bareMetal :: Lens' InstanceRequirements (Maybe BareMetal)
- instanceRequirements_baselineEbsBandwidthMbps :: Lens' InstanceRequirements (Maybe BaselineEbsBandwidthMbpsRequest)
- instanceRequirements_burstablePerformance :: Lens' InstanceRequirements (Maybe BurstablePerformance)
- instanceRequirements_cpuManufacturers :: Lens' InstanceRequirements (Maybe [CpuManufacturer])
- instanceRequirements_excludedInstanceTypes :: Lens' InstanceRequirements (Maybe [Text])
- instanceRequirements_instanceGenerations :: Lens' InstanceRequirements (Maybe [InstanceGeneration])
- instanceRequirements_localStorage :: Lens' InstanceRequirements (Maybe LocalStorage)
- instanceRequirements_localStorageTypes :: Lens' InstanceRequirements (Maybe [LocalStorageType])
- instanceRequirements_memoryGiBPerVCpu :: Lens' InstanceRequirements (Maybe MemoryGiBPerVCpuRequest)
- instanceRequirements_networkBandwidthGbps :: Lens' InstanceRequirements (Maybe NetworkBandwidthGbpsRequest)
- instanceRequirements_networkInterfaceCount :: Lens' InstanceRequirements (Maybe NetworkInterfaceCountRequest)
- instanceRequirements_onDemandMaxPricePercentageOverLowestPrice :: Lens' InstanceRequirements (Maybe Natural)
- instanceRequirements_requireHibernateSupport :: Lens' InstanceRequirements (Maybe Bool)
- instanceRequirements_spotMaxPricePercentageOverLowestPrice :: Lens' InstanceRequirements (Maybe Natural)
- instanceRequirements_totalLocalStorageGB :: Lens' InstanceRequirements (Maybe TotalLocalStorageGBRequest)
- instanceRequirements_vCpuCount :: Lens' InstanceRequirements VCpuCountRequest
- instanceRequirements_memoryMiB :: Lens' InstanceRequirements MemoryMiBRequest
Documentation
data InstanceRequirements Source #
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: newInstanceRequirements
smart constructor.
InstanceRequirements' | |
|
Instances
newInstanceRequirements Source #
Create a value of InstanceRequirements
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceleratorCount:InstanceRequirements'
, instanceRequirements_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
$sel:acceleratorManufacturers:InstanceRequirements'
, instanceRequirements_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
$sel:acceleratorNames:InstanceRequirements'
, instanceRequirements_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
$sel:acceleratorTotalMemoryMiB:InstanceRequirements'
, instanceRequirements_acceleratorTotalMemoryMiB
- The minimum and maximum total memory size for the accelerators on an
instance type, in MiB.
Default: No minimum or maximum limits
$sel:acceleratorTypes:InstanceRequirements'
, instanceRequirements_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
$sel:allowedInstanceTypes:InstanceRequirements'
, instanceRequirements_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
$sel:bareMetal:InstanceRequirements'
, instanceRequirements_bareMetal
- Indicates whether bare metal instance types are included, excluded, or
required.
Default: excluded
$sel:baselineEbsBandwidthMbps:InstanceRequirements'
, instanceRequirements_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
$sel:burstablePerformance:InstanceRequirements'
, instanceRequirements_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
$sel:cpuManufacturers:InstanceRequirements'
, instanceRequirements_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
$sel:excludedInstanceTypes:InstanceRequirements'
, instanceRequirements_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
$sel:instanceGenerations:InstanceRequirements'
, instanceRequirements_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
$sel:localStorage:InstanceRequirements'
, instanceRequirements_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
$sel:localStorageTypes:InstanceRequirements'
, instanceRequirements_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
$sel:memoryGiBPerVCpu:InstanceRequirements'
, instanceRequirements_memoryGiBPerVCpu
- The minimum and maximum amount of memory per vCPU for an instance type,
in GiB.
Default: No minimum or maximum limits
$sel:networkBandwidthGbps:InstanceRequirements'
, instanceRequirements_networkBandwidthGbps
- The minimum and maximum amount of network bandwidth, in gigabits per
second (Gbps).
Default: No minimum or maximum limits
$sel:networkInterfaceCount:InstanceRequirements'
, instanceRequirements_networkInterfaceCount
- The minimum and maximum number of network interfaces for an instance
type.
Default: No minimum or maximum limits
$sel:onDemandMaxPricePercentageOverLowestPrice:InstanceRequirements'
, instanceRequirements_onDemandMaxPricePercentageOverLowestPrice
- The price protection threshold for On-Demand Instances. This is the
maximum you’ll pay for an On-Demand Instance, expressed as a percentage
higher than the least expensive current generation M, C, or R instance
type with your specified attributes. When Amazon EC2 Auto Scaling
selects instance types with your attributes, we will exclude instance
types whose price is higher than your 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
$sel:requireHibernateSupport:InstanceRequirements'
, instanceRequirements_requireHibernateSupport
- Indicates whether instance types must provide On-Demand Instance
hibernation support.
Default: false
$sel:spotMaxPricePercentageOverLowestPrice:InstanceRequirements'
, instanceRequirements_spotMaxPricePercentageOverLowestPrice
- The price protection threshold for Spot Instances. This is the maximum
you’ll pay for a Spot Instance, expressed as a percentage higher than
the least expensive current generation M, C, or R instance type with
your specified attributes. When Amazon EC2 Auto Scaling selects instance
types with your attributes, we will exclude instance types whose price
is higher than your 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: 100
$sel:totalLocalStorageGB:InstanceRequirements'
, instanceRequirements_totalLocalStorageGB
- The minimum and maximum total local storage size for an instance type,
in GB.
Default: No minimum or maximum limits
$sel:vCpuCount:InstanceRequirements'
, instanceRequirements_vCpuCount
- The minimum and maximum number of vCPUs for an instance type.
$sel:memoryMiB:InstanceRequirements'
, instanceRequirements_memoryMiB
- The minimum and maximum instance memory size for an instance type, in
MiB.
instanceRequirements_acceleratorCount :: Lens' InstanceRequirements (Maybe AcceleratorCountRequest) Source #
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
instanceRequirements_acceleratorManufacturers :: Lens' InstanceRequirements (Maybe [AcceleratorManufacturer]) Source #
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
instanceRequirements_acceleratorNames :: Lens' InstanceRequirements (Maybe [AcceleratorName]) Source #
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
instanceRequirements_acceleratorTotalMemoryMiB :: Lens' InstanceRequirements (Maybe AcceleratorTotalMemoryMiBRequest) Source #
The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
Default: No minimum or maximum limits
instanceRequirements_acceleratorTypes :: Lens' InstanceRequirements (Maybe [AcceleratorType]) Source #
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
instanceRequirements_allowedInstanceTypes :: Lens' InstanceRequirements (Maybe [Text]) Source #
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
instanceRequirements_bareMetal :: Lens' InstanceRequirements (Maybe BareMetal) Source #
Indicates whether bare metal instance types are included, excluded, or required.
Default: excluded
instanceRequirements_baselineEbsBandwidthMbps :: Lens' InstanceRequirements (Maybe BaselineEbsBandwidthMbpsRequest) Source #
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
instanceRequirements_burstablePerformance :: Lens' InstanceRequirements (Maybe BurstablePerformance) Source #
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
instanceRequirements_cpuManufacturers :: Lens' InstanceRequirements (Maybe [CpuManufacturer]) Source #
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
instanceRequirements_excludedInstanceTypes :: Lens' InstanceRequirements (Maybe [Text]) Source #
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
instanceRequirements_instanceGenerations :: Lens' InstanceRequirements (Maybe [InstanceGeneration]) Source #
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
instanceRequirements_localStorage :: Lens' InstanceRequirements (Maybe LocalStorage) Source #
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
instanceRequirements_localStorageTypes :: Lens' InstanceRequirements (Maybe [LocalStorageType]) Source #
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
instanceRequirements_memoryGiBPerVCpu :: Lens' InstanceRequirements (Maybe MemoryGiBPerVCpuRequest) Source #
The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
Default: No minimum or maximum limits
instanceRequirements_networkBandwidthGbps :: Lens' InstanceRequirements (Maybe NetworkBandwidthGbpsRequest) Source #
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
instanceRequirements_networkInterfaceCount :: Lens' InstanceRequirements (Maybe NetworkInterfaceCountRequest) Source #
The minimum and maximum number of network interfaces for an instance type.
Default: No minimum or maximum limits
instanceRequirements_onDemandMaxPricePercentageOverLowestPrice :: Lens' InstanceRequirements (Maybe Natural) Source #
The price protection threshold for On-Demand Instances. This is the
maximum you’ll pay for an On-Demand Instance, expressed as a percentage
higher than the least expensive current generation M, C, or R instance
type with your specified attributes. When Amazon EC2 Auto Scaling
selects instance types with your attributes, we will exclude instance
types whose price is higher than your 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
instanceRequirements_requireHibernateSupport :: Lens' InstanceRequirements (Maybe Bool) Source #
Indicates whether instance types must provide On-Demand Instance hibernation support.
Default: false
instanceRequirements_spotMaxPricePercentageOverLowestPrice :: Lens' InstanceRequirements (Maybe Natural) Source #
The price protection threshold for Spot Instances. This is the maximum
you’ll pay for a Spot Instance, expressed as a percentage higher than
the least expensive current generation M, C, or R instance type with
your specified attributes. When Amazon EC2 Auto Scaling selects instance
types with your attributes, we will exclude instance types whose price
is higher than your 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: 100
instanceRequirements_totalLocalStorageGB :: Lens' InstanceRequirements (Maybe TotalLocalStorageGBRequest) Source #
The minimum and maximum total local storage size for an instance type, in GB.
Default: No minimum or maximum limits
instanceRequirements_vCpuCount :: Lens' InstanceRequirements VCpuCountRequest Source #
The minimum and maximum number of vCPUs for an instance type.
instanceRequirements_memoryMiB :: Lens' InstanceRequirements MemoryMiBRequest Source #
The minimum and maximum instance memory size for an instance type, in MiB.