Class InstanceRequirementsConfig

The attributes for the instance types for a mixed instances policy.

Inheritance

object

InstanceRequirementsConfig

Implements

IInstanceRequirementsConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class InstanceRequirementsConfig : IInstanceRequirementsConfig

Syntax (vb)

Public Class InstanceRequirementsConfig Implements IInstanceRequirementsConfig

Remarks

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:

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

ExampleMetadata: infused

Examples

Vpc vpc;
             Role infrastructureRole;
             InstanceProfile instanceProfile;


             var cluster = new Cluster(this, "Cluster", new ClusterProps { Vpc = vpc });

             // Create a Managed Instances Capacity Provider
             var miCapacityProvider = new ManagedInstancesCapacityProvider(this, "MICapacityProvider", new ManagedInstancesCapacityProviderProps {
                 InfrastructureRole = infrastructureRole,
                 Ec2InstanceProfile = instanceProfile,
                 Subnets = vpc.PrivateSubnets,
                 SecurityGroups = new [] { new SecurityGroup(this, "MISecurityGroup", new SecurityGroupProps { Vpc = vpc }) },
                 InstanceRequirements = new InstanceRequirementsConfig {
                     VCpuCountMin = 1,
                     MemoryMin = Size.Gibibytes(2),
                     CpuManufacturers = new [] { CpuManufacturer.INTEL },
                     AcceleratorManufacturers = new [] { AcceleratorManufacturer.NVIDIA }
                 },
                 PropagateTags = PropagateManagedInstancesTags.CAPACITY_PROVIDER
             });

             // Optionally configure security group rules using IConnectable interface
             miCapacityProvider.Connections.AllowFrom(Peer.Ipv4(vpc.VpcCidrBlock), Port.Tcp(80));

             // Add the capacity provider to the cluster
             cluster.AddManagedInstancesCapacityProvider(miCapacityProvider);

             var taskDefinition = new TaskDefinition(this, "TaskDef", new TaskDefinitionProps {
                 MemoryMiB = "512",
                 Cpu = "256",
                 NetworkMode = NetworkMode.AWS_VPC,
                 Compatibility = Compatibility.MANAGED_INSTANCES
             });

             taskDefinition.AddContainer("web", new ContainerDefinitionOptions {
                 Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample"),
                 MemoryReservationMiB = 256
             });

             new FargateService(this, "FargateService", new FargateServiceProps {
                 Cluster = cluster,
                 TaskDefinition = taskDefinition,
                 MinHealthyPercent = 100,
                 CapacityProviderStrategies = new [] { new CapacityProviderStrategy {
                     CapacityProvider = miCapacityProvider.CapacityProviderName,
                     Weight = 1
                 } }
             });

Synopsis

Constructors

InstanceRequirementsConfig()

The attributes for the instance types for a mixed instances policy.

Properties

AcceleratorCountMax	The maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
AcceleratorCountMin	The minimum 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.
AcceleratorTotalMemoryMax	The maximum total memory size for the accelerators on an instance type, in MiB.
AcceleratorTotalMemoryMin	The minimum 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.
BaselineEbsBandwidthMbpsMax	The maximum baseline bandwidth performance for an instance type, in Mbps.
BaselineEbsBandwidthMbpsMin	The minimum 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.
MemoryMax	The maximum instance memory size for an instance type, in MiB.
MemoryMin	The minimum instance memory size for an instance type, in MiB.
MemoryPerVCpuMax	The maximum amount of memory per vCPU for an instance type, in GiB.
MemoryPerVCpuMin	The minimum amount of memory per vCPU for an instance type, in GiB.
NetworkBandwidthGbpsMax	The maximum amount of network bandwidth, in gigabits per second (Gbps).
NetworkBandwidthGbpsMin	The minimum amount of network bandwidth, in gigabits per second (Gbps).
NetworkInterfaceCountMax	The maximum number of network interfaces for an instance type.
NetworkInterfaceCountMin	The minimum 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.
TotalLocalStorageGBMax	The maximum total local storage size for an instance type, in GB.
TotalLocalStorageGBMin	The minimum total local storage size for an instance type, in GB.
VCpuCountMax	The maximum number of vCPUs for an instance type.
VCpuCountMin	The minimum number of vCPUs for an instance type.

Constructors

InstanceRequirementsConfig()

The attributes for the instance types for a mixed instances policy.

public InstanceRequirementsConfig()

Remarks

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:

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

ExampleMetadata: infused

Examples

Vpc vpc;
             Role infrastructureRole;
             InstanceProfile instanceProfile;


             var cluster = new Cluster(this, "Cluster", new ClusterProps { Vpc = vpc });

             // Create a Managed Instances Capacity Provider
             var miCapacityProvider = new ManagedInstancesCapacityProvider(this, "MICapacityProvider", new ManagedInstancesCapacityProviderProps {
                 InfrastructureRole = infrastructureRole,
                 Ec2InstanceProfile = instanceProfile,
                 Subnets = vpc.PrivateSubnets,
                 SecurityGroups = new [] { new SecurityGroup(this, "MISecurityGroup", new SecurityGroupProps { Vpc = vpc }) },
                 InstanceRequirements = new InstanceRequirementsConfig {
                     VCpuCountMin = 1,
                     MemoryMin = Size.Gibibytes(2),
                     CpuManufacturers = new [] { CpuManufacturer.INTEL },
                     AcceleratorManufacturers = new [] { AcceleratorManufacturer.NVIDIA }
                 },
                 PropagateTags = PropagateManagedInstancesTags.CAPACITY_PROVIDER
             });

             // Optionally configure security group rules using IConnectable interface
             miCapacityProvider.Connections.AllowFrom(Peer.Ipv4(vpc.VpcCidrBlock), Port.Tcp(80));

             // Add the capacity provider to the cluster
             cluster.AddManagedInstancesCapacityProvider(miCapacityProvider);

             var taskDefinition = new TaskDefinition(this, "TaskDef", new TaskDefinitionProps {
                 MemoryMiB = "512",
                 Cpu = "256",
                 NetworkMode = NetworkMode.AWS_VPC,
                 Compatibility = Compatibility.MANAGED_INSTANCES
             });

             taskDefinition.AddContainer("web", new ContainerDefinitionOptions {
                 Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample"),
                 MemoryReservationMiB = 256
             });

             new FargateService(this, "FargateService", new FargateServiceProps {
                 Cluster = cluster,
                 TaskDefinition = taskDefinition,
                 MinHealthyPercent = 100,
                 CapacityProviderStrategies = new [] { new CapacityProviderStrategy {
                     CapacityProvider = miCapacityProvider.CapacityProviderName,
                     Weight = 1
                 } }
             });

Properties

AcceleratorCountMax

The maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.

public double? AcceleratorCountMax { get; set; }

Property Value

double?

Remarks

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

Default: - No minimum or maximum limits

AcceleratorCountMin

The minimum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.

public double? AcceleratorCountMin { get; set; }

Property Value

double?

Remarks

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

Default: - No minimum or maximum limits

AcceleratorManufacturers

Indicates whether instance types must have accelerators by specific manufacturers.

public AcceleratorManufacturer[]? AcceleratorManufacturers { get; set; }

Property Value

AcceleratorManufacturer[]

Remarks

Default: - Any manufacturer

AcceleratorNames

Lists the accelerators that must be on an instance type.

public AcceleratorName[]? AcceleratorNames { get; set; }

Property Value

AcceleratorName[]

Remarks

Default: - Any accelerator

AcceleratorTotalMemoryMax

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

public Size? AcceleratorTotalMemoryMax { get; set; }

Property Value

Size

Remarks

Default: - No minimum or maximum limits

AcceleratorTotalMemoryMin

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

public Size? AcceleratorTotalMemoryMin { get; set; }

Property Value

Size

Remarks

Default: - No minimum or maximum limits

AcceleratorTypes

Lists the accelerator types that must be on an instance type.

public AcceleratorType[]? AcceleratorTypes { get; set; }

Property Value

AcceleratorType[]

Remarks

Default: - Any accelerator type

AllowedInstanceTypes

The instance types to apply your specified attributes against.

public string[]? AllowedInstanceTypes { get; set; }

Property Value

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.

Note: 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 BareMetal? BareMetal { get; set; }

Property Value

BareMetal?

Remarks

Default: - excluded

BaselineEbsBandwidthMbpsMax

The maximum baseline bandwidth performance for an instance type, in Mbps.

public double? BaselineEbsBandwidthMbpsMax { get; set; }

Property Value

double?

Remarks

For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.

Default: - No minimum or maximum limits

BaselineEbsBandwidthMbpsMin

The minimum baseline bandwidth performance for an instance type, in Mbps.

public double? BaselineEbsBandwidthMbpsMin { get; set; }

Property Value

double?

Remarks

For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.

Default: - No minimum or maximum limits

BurstablePerformance

Indicates whether burstable performance instance types are included, excluded, or required.

public BurstablePerformance? BurstablePerformance { get; set; }

Property Value

BurstablePerformance?

Remarks

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Default: - excluded

CpuManufacturers

Lists which specific CPU manufacturers to include.

public CpuManufacturer[]? CpuManufacturers { get; set; }

Property Value

CpuManufacturer[]

Remarks

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

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.

Note: 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 InstanceGeneration[]? InstanceGenerations { get; set; }

Property Value

InstanceGeneration[]

Remarks

Default: - Any current or previous generation

LocalStorage

Indicates whether instance types with instance store volumes are included, excluded, or required.

public LocalStorage? LocalStorage { get; set; }

Property Value

LocalStorage?

Remarks

For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.

Default: - included

LocalStorageTypes

Indicates the type of local storage that is required.

public LocalStorageType[]? LocalStorageTypes { get; set; }

Property Value

LocalStorageType[]

Remarks

Default: - Any local storage type

MaxSpotPriceAsPercentageOfOptimalOnDemandPrice

[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price.

public double? MaxSpotPriceAsPercentageOfOptimalOnDemandPrice { get; set; }

Property Value

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.

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

Default: - Automatic optimal price protection

MemoryMax

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

public Size? MemoryMax { get; set; }

Property Value

Size

Remarks

Default: - No maximum limit

MemoryMin

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

public Size MemoryMin { get; set; }

Property Value

Size

Remarks

Required: Yes

MemoryPerVCpuMax

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

public Size? MemoryPerVCpuMax { get; set; }

Property Value

Size

Remarks

Default: - No minimum or maximum limits

MemoryPerVCpuMin

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

public Size? MemoryPerVCpuMin { get; set; }

Property Value

Size

Remarks

Default: - No minimum or maximum limits

NetworkBandwidthGbpsMax

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

public double? NetworkBandwidthGbpsMax { get; set; }

Property Value

double?

Remarks

Default: - No minimum or maximum limits

NetworkBandwidthGbpsMin

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

public double? NetworkBandwidthGbpsMin { get; set; }

Property Value

double?

Remarks

Default: - No minimum or maximum limits

NetworkInterfaceCountMax

The maximum number of network interfaces for an instance type.

public double? NetworkInterfaceCountMax { get; set; }

Property Value

double?

Remarks

Default: - No minimum or maximum limits

NetworkInterfaceCountMin

The minimum number of network interfaces for an instance type.

public double? NetworkInterfaceCountMin { get; set; }

Property Value

double?

Remarks

Default: - No minimum or maximum limits

OnDemandMaxPricePercentageOverLowestPrice

[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price.

public double? OnDemandMaxPricePercentageOverLowestPrice { get; set; }

Property Value

double?

Remarks

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 bool? RequireHibernateSupport { get; set; }

Property Value

bool?

Remarks

Default: - false

SpotMaxPricePercentageOverLowestPrice

[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.

public double? SpotMaxPricePercentageOverLowestPrice { get; set; }

Property Value

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.

Default: - Automatic optimal price protection

TotalLocalStorageGBMax

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

public double? TotalLocalStorageGBMax { get; set; }

Property Value

double?

Remarks

Default: - No minimum or maximum limits

TotalLocalStorageGBMin

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

public double? TotalLocalStorageGBMin { get; set; }

Property Value

double?

Remarks

Default: - No minimum or maximum limits

VCpuCountMax

The maximum number of vCPUs for an instance type.

public double? VCpuCountMax { get; set; }

Property Value

double?

Remarks

Default: - No maximum limit

VCpuCountMin

The minimum number of vCPUs for an instance type.

public double VCpuCountMin { get; set; }

Property Value

double

Remarks

Required: Yes

Implements

IInstanceRequirementsConfig