Class CfnAutoScalingGroup.InstanceRequirementsProperty
The attributes for the instance types for a mixed instances policy.
Inheritance
Namespace: Amazon.CDK.AWS.AutoScaling
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class InstanceRequirementsProperty : Object, CfnAutoScalingGroup.IInstanceRequirementsProperty
Syntax (vb)
Public Class InstanceRequirementsProperty
Inherits Object
Implements CfnAutoScalingGroup.IInstanceRequirementsProperty
Remarks
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:
You must specify <code>VCpuCount</code> and <code>MemoryMiB</code> . All other attributes are optional. Any unspecified optional attribute is set to its default.
For an example template, see Configure Amazon EC2 Auto Scaling resources .
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 .
InstanceRequirements
is a property of the LaunchTemplateOverrides
property of the AWS::AutoScaling::AutoScalingGroup LaunchTemplate property type.
ExampleMetadata: infused
Examples
Vpc vpc;
LaunchTemplate launchTemplate1;
new AutoScalingGroup(this, "ASG", new AutoScalingGroupProps {
Vpc = vpc,
MixedInstancesPolicy = new MixedInstancesPolicy {
LaunchTemplate = launchTemplate1,
LaunchTemplateOverrides = new [] { new LaunchTemplateOverrides {
InstanceRequirements = new InstanceRequirementsProperty {
VCpuCount = new VCpuCountRequestProperty { Min = 4, Max = 8 },
MemoryMiB = new MemoryMiBRequestProperty { Min = 16384 },
CpuManufacturers = new [] { "intel" }
}
} }
}
});
Synopsis
Constructors
InstanceRequirementsProperty() |
Properties
AcceleratorCount | The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type. |
AcceleratorManufacturers | Indicates whether instance types must have accelerators by specific manufacturers. |
AcceleratorNames | Lists the accelerators that must be on an instance type. |
AcceleratorTotalMemoryMiB | The minimum and maximum total memory size for the accelerators on an instance type, in MiB. |
AcceleratorTypes | Lists the accelerator types that must be on an instance type. |
AllowedInstanceTypes | The instance types to apply your specified attributes against. |
BareMetal | Indicates whether bare metal instance types are included, excluded, or required. |
BaselineEbsBandwidthMbps | The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. |
BurstablePerformance | Indicates whether burstable performance instance types are included, excluded, or required. |
CpuManufacturers | Lists which specific CPU manufacturers to include. |
ExcludedInstanceTypes | The instance types to exclude. |
InstanceGenerations | Indicates whether current or previous generation instance types are included. |
LocalStorage | Indicates whether instance types with instance store volumes are included, excluded, or required. |
LocalStorageTypes | Indicates the type of local storage that is required. |
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice | [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. |
MemoryGiBPerVCpu | The minimum and maximum amount of memory per vCPU for an instance type, in GiB. |
MemoryMiB | The minimum and maximum instance memory size for an instance type, in MiB. |
NetworkBandwidthGbps | The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). |
NetworkInterfaceCount | The minimum and maximum number of network interfaces for an instance type. |
OnDemandMaxPricePercentageOverLowestPrice | [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. |
RequireHibernateSupport | Indicates whether instance types must provide On-Demand Instance hibernation support. |
SpotMaxPricePercentageOverLowestPrice | [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. |
TotalLocalStorageGb | The minimum and maximum total local storage size for an instance type, in GB. |
VCpuCount | The minimum and maximum number of vCPUs for an instance type. |
Constructors
InstanceRequirementsProperty()
public InstanceRequirementsProperty()
Properties
AcceleratorCount
The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
public object AcceleratorCount { get; set; }
Property Value
System.Object
Remarks
To exclude accelerator-enabled instance types, set Max
to 0
.
Default: No minimum or maximum limits
AcceleratorManufacturers
Indicates whether instance types must have accelerators by specific manufacturers.
public string[] AcceleratorManufacturers { get; set; }
Property Value
System.String[]
Remarks
AcceleratorNames
Lists the accelerators that must be on an instance type.
public string[] AcceleratorNames { get; set; }
Property Value
System.String[]
Remarks
AcceleratorTotalMemoryMiB
The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
public object AcceleratorTotalMemoryMiB { get; set; }
Property Value
System.Object
Remarks
AcceleratorTypes
Lists the accelerator types that must be on an instance type.
public string[] AcceleratorTypes { get; set; }
Property Value
System.String[]
Remarks
AllowedInstanceTypes
The instance types to apply your specified attributes against.
public string[] AllowedInstanceTypes { get; set; }
Property Value
System.String[]
Remarks
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
BareMetal
Indicates whether bare metal instance types are included, excluded, or required.
public string BareMetal { get; set; }
Property Value
System.String
Remarks
BaselineEbsBandwidthMbps
The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.
public object BaselineEbsBandwidthMbps { get; set; }
Property Value
System.Object
Remarks
For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances .
Default: No minimum or maximum limits
BurstablePerformance
Indicates whether burstable performance instance types are included, excluded, or required.
public string BurstablePerformance { get; set; }
Property Value
System.String
Remarks
For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances .
Default: excluded
CpuManufacturers
Lists which specific CPU manufacturers to include.
public string[] CpuManufacturers { get; set; }
Property Value
System.String[]
Remarks
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
ExcludedInstanceTypes
The instance types to exclude.
public string[] ExcludedInstanceTypes { get; set; }
Property Value
System.String[]
Remarks
You can use strings with one or more wild cards, represented by an asterisk ( ), to exclude an instance family, type, size, or generation. The following are examples:
m5.8xlarge
, c5.
, m5a.
, r*
, 3
.
For example, if you specify c5*
, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*
, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.
If you specify ExcludedInstanceTypes
, you can't specify AllowedInstanceTypes
.
Default: No excluded instance types
InstanceGenerations
Indicates whether current or previous generation instance types are included.
public string[] InstanceGenerations { get; set; }
Property Value
System.String[]
Remarks
LocalStorage
Indicates whether instance types with instance store volumes are included, excluded, or required.
public string LocalStorage { get; set; }
Property Value
System.String
Remarks
For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances .
Default: included
LocalStorageTypes
Indicates the type of local storage that is required.
public string[] LocalStorageTypes { get; set; }
Property Value
System.String[]
Remarks
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price.
public Nullable<double> MaxSpotPriceAsPercentageOfOptimalOnDemandPrice { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
If you set DesiredCapacityType
to vcpu
or memory-mib
, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice
or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999
.
MemoryGiBPerVCpu
The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
public object MemoryGiBPerVCpu { get; set; }
Property Value
System.Object
Remarks
MemoryMiB
The minimum and maximum instance memory size for an instance type, in MiB.
public object MemoryMiB { get; set; }
Property Value
System.Object
Remarks
NetworkBandwidthGbps
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
public object NetworkBandwidthGbps { get; set; }
Property Value
System.Object
Remarks
NetworkInterfaceCount
The minimum and maximum number of network interfaces for an instance type.
public object NetworkInterfaceCount { get; set; }
Property Value
System.Object
Remarks
OnDemandMaxPricePercentageOverLowestPrice
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price.
public Nullable<double> OnDemandMaxPricePercentageOverLowestPrice { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
To turn off price protection, specify a high value, such as 999999
.
If you set DesiredCapacityType
to vcpu
or memory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price.
Default: 20
RequireHibernateSupport
Indicates whether instance types must provide On-Demand Instance hibernation support.
public object RequireHibernateSupport { get; set; }
Property Value
System.Object
Remarks
SpotMaxPricePercentageOverLowestPrice
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.
public Nullable<double> SpotMaxPricePercentageOverLowestPrice { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
If you set DesiredCapacityType
to vcpu
or memory-mib
, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice
or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999
.
TotalLocalStorageGb
The minimum and maximum total local storage size for an instance type, in GB.
public object TotalLocalStorageGb { get; set; }
Property Value
System.Object
Remarks
VCpuCount
The minimum and maximum number of vCPUs for an instance type.
public object VCpuCount { get; set; }
Property Value
System.Object