Class ManagedEc2EksComputeEnvironmentProps
Props for a ManagedEc2EksComputeEnvironment.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ManagedEc2EksComputeEnvironmentProps : IManagedEc2EksComputeEnvironmentProps, IManagedComputeEnvironmentProps, IComputeEnvironmentPropsSyntax (vb)
Public Class ManagedEc2EksComputeEnvironmentProps Implements IManagedEc2EksComputeEnvironmentProps, IManagedComputeEnvironmentProps, IComputeEnvironmentPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Batch;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.EKS;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.Interfaces.EC2;
Cluster cluster;
InstanceType instanceType;
LaunchTemplate launchTemplate;
IMachineImage machineImage;
IPlacementGroupRef placementGroupRef;
Role role;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;
var managedEc2EksComputeEnvironmentProps = new ManagedEc2EksComputeEnvironmentProps {
EksCluster = cluster,
KubernetesNamespace = "kubernetesNamespace",
Vpc = vpc,
// the properties below are optional
AllocationStrategy = AllocationStrategy.BEST_FIT,
ComputeEnvironmentName = "computeEnvironmentName",
DefaultInstanceClasses = new [] { DefaultInstanceClass.X86_64 },
Enabled = false,
Images = new [] { new EksMachineImage {
Image = machineImage,
ImageType = EksMachineImageType.EKS_AL2
} },
InstanceClasses = new [] { InstanceClass.STANDARD3 },
InstanceRole = role,
InstanceTypes = new [] { instanceType },
LaunchTemplate = launchTemplate,
MaxvCpus = 123,
MinvCpus = 123,
PlacementGroup = placementGroupRef,
ReplaceComputeEnvironment = false,
SecurityGroups = new [] { securityGroup },
ServiceRole = role,
Spot = false,
SpotBidPercentage = 123,
TerminateOnUpdate = false,
UpdateTimeout = Duration.Minutes(30),
UpdateToLatestImageVersion = false,
UseOptimalInstanceClasses = false,
VpcSubnets = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
Subnets = new [] { subnet },
SubnetType = SubnetType.PRIVATE_ISOLATED
}
};Synopsis
Constructors
| ManagedEc2EksComputeEnvironmentProps() | Props for a ManagedEc2EksComputeEnvironment. |
Properties
| AllocationStrategy | The allocation strategy to use if not enough instances of the best fitting instance type can be allocated. |
| ComputeEnvironmentName | The name of the ComputeEnvironment. |
| DefaultInstanceClasses | Use batch's default instance types. |
| EksCluster | The cluster that backs this Compute Environment. Required for Compute Environments running Kubernetes jobs. |
| Enabled | Whether or not this ComputeEnvironment can accept jobs from a Queue. |
| Images | Configure which AMIs this Compute Environment can launch. |
| InstanceClasses | The instance types that this Compute Environment can launch. |
| InstanceRole | The execution Role that instances launched by this Compute Environment will use. |
| InstanceTypes | The instance types that this Compute Environment can launch. |
| KubernetesNamespace | The namespace of the Cluster. |
| LaunchTemplate | The Launch Template that this Compute Environment will use to provision EC2 Instances. |
| MaxvCpus | The maximum vCpus this |
| MinvCpus | The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED. |
| PlacementGroup | The EC2 placement group to associate with your compute resources. |
| ReplaceComputeEnvironment | Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances. |
| SecurityGroups | The security groups this Compute Environment will launch instances in. |
| ServiceRole | The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs. |
| Spot | Whether or not to use spot instances. |
| SpotBidPercentage | The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. |
| TerminateOnUpdate | Whether or not any running jobs will be immediately terminated when an infrastructure update occurs. |
| UpdateTimeout | Only meaningful if |
| UpdateToLatestImageVersion | Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs. |
| UseOptimalInstanceClasses | Whether or not to use batch's optimal instance type. |
| Vpc | VPC in which this Compute Environment will launch Instances. |
| VpcSubnets | The VPC Subnets this Compute Environment will launch instances in. |
Constructors
ManagedEc2EksComputeEnvironmentProps()
Props for a ManagedEc2EksComputeEnvironment.
public ManagedEc2EksComputeEnvironmentProps()Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Batch;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.EKS;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.Interfaces.EC2;
Cluster cluster;
InstanceType instanceType;
LaunchTemplate launchTemplate;
IMachineImage machineImage;
IPlacementGroupRef placementGroupRef;
Role role;
SecurityGroup securityGroup;
Subnet subnet;
SubnetFilter subnetFilter;
Vpc vpc;
var managedEc2EksComputeEnvironmentProps = new ManagedEc2EksComputeEnvironmentProps {
EksCluster = cluster,
KubernetesNamespace = "kubernetesNamespace",
Vpc = vpc,
// the properties below are optional
AllocationStrategy = AllocationStrategy.BEST_FIT,
ComputeEnvironmentName = "computeEnvironmentName",
DefaultInstanceClasses = new [] { DefaultInstanceClass.X86_64 },
Enabled = false,
Images = new [] { new EksMachineImage {
Image = machineImage,
ImageType = EksMachineImageType.EKS_AL2
} },
InstanceClasses = new [] { InstanceClass.STANDARD3 },
InstanceRole = role,
InstanceTypes = new [] { instanceType },
LaunchTemplate = launchTemplate,
MaxvCpus = 123,
MinvCpus = 123,
PlacementGroup = placementGroupRef,
ReplaceComputeEnvironment = false,
SecurityGroups = new [] { securityGroup },
ServiceRole = role,
Spot = false,
SpotBidPercentage = 123,
TerminateOnUpdate = false,
UpdateTimeout = Duration.Minutes(30),
UpdateToLatestImageVersion = false,
UseOptimalInstanceClasses = false,
VpcSubnets = new SubnetSelection {
AvailabilityZones = new [] { "availabilityZones" },
OnePerAz = false,
SubnetFilters = new [] { subnetFilter },
SubnetGroupName = "subnetGroupName",
Subnets = new [] { subnet },
SubnetType = SubnetType.PRIVATE_ISOLATED
}
};Properties
AllocationStrategy
The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.
public AllocationStrategy? AllocationStrategy { get; set; }Property Value
Remarks
Default: - BEST_FIT_PROGRESSIVE if not using Spot instances,
SPOT_PRICE_CAPACITY_OPTIMIZED if using Spot instances.
ComputeEnvironmentName
The name of the ComputeEnvironment.
public string? ComputeEnvironmentName { get; set; }Property Value
Remarks
Default: - generated by CloudFormation
DefaultInstanceClasses
Use batch's default instance types.
public DefaultInstanceClass[]? DefaultInstanceClasses { get; set; }Property Value
Remarks
A simpler way to choose up-to-date instance classes based on region instead of specifying exact instance classes.
Default: - choose from instanceTypes and instanceClasses
See: https://docs.aws.amazon.com/batch/latest/userguide/instance-type-compute-table.html
EksCluster
The cluster that backs this Compute Environment. Required for Compute Environments running Kubernetes jobs.
public ICluster EksCluster { get; set; }Property Value
Remarks
Please ensure that you have followed the steps at
https://docs.aws.amazon.com/batch/latest/userguide/getting-started-eks.html
before attempting to deploy a ManagedEc2EksComputeEnvironment that uses this cluster.
If you do not follow the steps in the link, the deployment fail with a message that the
compute environment did not stabilize.
Enabled
Whether or not this ComputeEnvironment can accept jobs from a Queue.
public bool? Enabled { get; set; }Property Value
bool?
Remarks
Enabled ComputeEnvironments can accept jobs from a Queue and can scale instances up or down. Disabled ComputeEnvironments cannot accept jobs from a Queue or scale instances up or down.
If you change a ComputeEnvironment from enabled to disabled while it is executing jobs,
Jobs in the STARTED or RUNNING states will not
be interrupted. As jobs complete, the ComputeEnvironment will scale instances down to minvCpus.
To ensure you aren't billed for unused capacity, set minvCpus to 0.
Default: true
Images
Configure which AMIs this Compute Environment can launch.
public IEksMachineImage[]? Images { get; set; }Property Value
Remarks
Default: If imageKubernetesVersion is specified,
- EKS_AL2 for non-GPU instances, EKS_AL2_NVIDIA for GPU instances, Otherwise,
- ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances,
InstanceClasses
The instance types that this Compute Environment can launch.
public InstanceClass[]? InstanceClasses { get; set; }Property Value
Remarks
Which one is chosen depends on the AllocationStrategy used.
Batch will automatically choose the instance size.
Default: - the instances Batch considers will be used (currently C4, M4, and R4)
InstanceRole
The execution Role that instances launched by this Compute Environment will use.
public IRole? InstanceRole { get; set; }Property Value
Remarks
Default: - a role will be created
InstanceTypes
The instance types that this Compute Environment can launch.
public InstanceType[]? InstanceTypes { get; set; }Property Value
Remarks
Which one is chosen depends on the AllocationStrategy used.
Default: - the instances Batch considers will be used (currently C4, M4, and R4)
KubernetesNamespace
The namespace of the Cluster.
public string KubernetesNamespace { get; set; }Property Value
Remarks
ExampleMetadata: fixture=_generated
LaunchTemplate
The Launch Template that this Compute Environment will use to provision EC2 Instances.
public ILaunchTemplate? LaunchTemplate { get; set; }Property Value
Remarks
Note: if securityGroups is specified on both your
launch template and this Compute Environment, the
securityGroups on the Compute Environment override the
ones on the launch template.
Default: - no launch template
MaxvCpus
The maximum vCpus this ManagedComputeEnvironment can scale up to. Each vCPU is equivalent to 1024 CPU shares.
public double? MaxvCpus { get; set; }Property Value
Remarks
Note: if this Compute Environment uses EC2 resources (not Fargate) with either AllocationStrategy.BEST_FIT_PROGRESSIVE or
AllocationStrategy.SPOT_CAPACITY_OPTIMIZED, or AllocationStrategy.BEST_FIT with Spot instances,
The scheduler may exceed this number by at most one of the instances specified in instanceTypes
or instanceClasses.
Default: 256
MinvCpus
The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.
public double? MinvCpus { get; set; }Property Value
Remarks
Default: 0
PlacementGroup
The EC2 placement group to associate with your compute resources.
public IPlacementGroupRef? PlacementGroup { get; set; }Property Value
Remarks
If you intend to submit multi-node parallel jobs to this Compute Environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential.
Default: - no placement group
See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html
ReplaceComputeEnvironment
Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
public bool? ReplaceComputeEnvironment { get; set; }Property Value
bool?
Remarks
To enable more properties to be updated,
set this property to false. When changing the value of this property to false,
do not change any other properties at the same time.
If other properties are changed at the same time,
and the change needs to be rolled back but it can't,
it's possible for the stack to go into the UPDATE_ROLLBACK_FAILED state.
You can't update a stack that is in the UPDATE_ROLLBACK_FAILED state.
However, if you can continue to roll it back,
you can return the stack to its original settings and then try to update it again.
The properties which require a replacement of the Compute Environment are:
Default: false
SecurityGroups
The security groups this Compute Environment will launch instances in.
public ISecurityGroup[]? SecurityGroups { get; set; }Property Value
Remarks
Default: new security groups will be created
ServiceRole
The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
public IRole? ServiceRole { get; set; }Property Value
Remarks
Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs
Spot
Whether or not to use spot instances.
public bool? Spot { get; set; }Property Value
bool?
Remarks
Spot instances are less expensive EC2 instances that can be reclaimed by EC2 at any time; your job will be given two minutes of notice before reclamation.
Default: false
SpotBidPercentage
The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.
public double? SpotBidPercentage { get; set; }Property Value
Remarks
For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Instance. You always pay the lowest market price and never more than your maximum percentage. For most use cases, Batch recommends leaving this field empty.
Implies spot == true if set
Default: - 100%
TerminateOnUpdate
Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.
public bool? TerminateOnUpdate { get; set; }Property Value
bool?
Remarks
If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.
Default: false
See: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
UpdateTimeout
Only meaningful if terminateOnUpdate is false.
public Duration? UpdateTimeout { get; set; }Property Value
Remarks
If so,
when an infrastructure update is triggered, any running jobs
will be allowed to run until updateTimeout has expired.
Default: 30 minutes
See: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html
UpdateToLatestImageVersion
Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.
public bool? UpdateToLatestImageVersion { get; set; }Property Value
bool?
Remarks
If you specify a specific AMI, this property will be ignored.
Note: the CDK will never set this value by default, false will set by CFN.
This is to avoid a deployment failure that occurs when this value is set.
Default: false
UseOptimalInstanceClasses
Whether or not to use batch's optimal instance type.
public bool? UseOptimalInstanceClasses { get; set; }Property Value
bool?
Remarks
The optimal instance type is equivalent to adding the C4, M4, and R4 instance classes. You can specify other instance classes (of the same architecture) in addition to the optimal instance classes.
Default: true
Vpc
VPC in which this Compute Environment will launch Instances.
public IVpc Vpc { get; set; }Property Value
Remarks
ExampleMetadata: fixture=_generated
VpcSubnets
The VPC Subnets this Compute Environment will launch instances in.
public ISubnetSelection? VpcSubnets { get; set; }Property Value
Remarks
Default: new subnets will be created