ManagedEc2EcsComputeEnvironment
A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.
Import
import { ManagedEc2EcsComputeEnvironment } from 'aws-cdk-lib/aws-batch';Or use the module namespace:
import * as batch from 'aws-cdk-lib/aws-batch';
// batch.ManagedEc2EcsComputeEnvironmentProperties
Configuration passed to the constructor as ManagedEc2EcsComputeEnvironmentProps.
allocationStrategyOptionalAllocationStrategyThe allocation strategy to use if not enough instances of the best fitting instance type can be allocated.
Default: - `BEST_FIT_PROGRESSIVE` if not using Spot instances,
`SPOT_PRICE_CAPACITY_OPTIMIZED` if using Spot instances.
defaultInstanceClassesOptionalDefaultInstanceClass[]Use batch's default instance types. 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
imagesOptionalEcsMachineImage[]Configure which AMIs this Compute Environment can launch. If you specify this property with only `image` specified, then the `imageType` will default to `ECS_AL2` (or `ECS_AL2023` if the `@aws-cdk/aws-batch:defaultToAL2023` feature flag is set). *If your image needs GPU resources, specify `ECS_AL2_NVIDIA` or `ECS_AL2023_NVIDIA`; otherwise, the instances will not be able to properly join the ComputeEnvironment*.
Default: - ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances.
If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, ECS_AL2023 will be used instead of ECS_AL2.
instanceRoleOptionalIRoleThe execution Role that instances launched by this Compute Environment will use.
Default: - a role will be created
launchTemplateOptionalILaunchTemplateThe Launch Template that this Compute Environment will use to provision EC2 Instances. *Note*: if `securityGroups` is specified on both your launch template and this Compute Environment, **the `securityGroup`s on the Compute Environment override the ones on the launch template.
Default: no launch template
minvCpusOptionalnumberThe minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.
Default: 0
placementGroupOptionalIPlacementGroupRefThe EC2 placement group to associate with your compute resources. 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
spotBidPercentageOptionalnumberThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. 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%
spotFleetRoleOptionalIRoleThe service-linked role that Spot Fleet needs to launch instances on your behalf.
Default: - a new role will be created
useOptimalInstanceClassesOptionalbooleanWhether or not to use batch's optimal instance type. 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
2 properties inherited from ManagedEc2ComputeEnvironmentProps
instanceClassesOptionalinherited from ManagedEc2ComputeEnvironmentPropsInstanceClass[]The instance classes that this Compute Environment can launch. 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)
instanceTypesOptionalinherited from ManagedEc2ComputeEnvironmentPropsInstanceType[]The instance types that this Compute Environment can launch. Which one is chosen depends on the `AllocationStrategy` used.
Default: - the instances Batch considers will be used (currently C4, M4, and R4)
9 properties inherited from ManagedComputeEnvironmentProps
vpcRequiredinherited from ManagedComputeEnvironmentPropsIVpcVPC in which this Compute Environment will launch Instances.
maxvCpusOptionalinherited from ManagedComputeEnvironmentPropsnumberThe maximum vCpus this `ManagedComputeEnvironment` can scale up to. Each vCPU is equivalent to 1024 CPU shares. *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
replaceComputeEnvironmentOptionalinherited from ManagedComputeEnvironmentPropsbooleanSpecifies whether this Compute Environment is replaced if an update is made that requires replacing its instances. 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
securityGroupsOptionalinherited from ManagedComputeEnvironmentPropsISecurityGroup[]The security groups this Compute Environment will launch instances in.
Default: new security groups will be created
spotOptionalinherited from ManagedComputeEnvironmentPropsbooleanWhether or not to use spot instances. 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
terminateOnUpdateOptionalinherited from ManagedComputeEnvironmentPropsbooleanWhether or not any running jobs will be immediately terminated when an infrastructure update occurs. If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.
Default: false
updateTimeoutOptionalinherited from ManagedComputeEnvironmentPropsDurationOnly meaningful if `terminateOnUpdate` is `false`. If so, when an infrastructure update is triggered, any running jobs will be allowed to run until `updateTimeout` has expired.
Default: 30 minutes
updateToLatestImageVersionOptionalinherited from ManagedComputeEnvironmentPropsbooleanWhether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs. 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
vpcSubnetsOptionalinherited from ManagedComputeEnvironmentPropsSubnetSelectionThe VPC Subnets this Compute Environment will launch instances in.
Default: new subnets will be created
3 properties inherited from ComputeEnvironmentProps
computeEnvironmentNameOptionalinherited from ComputeEnvironmentPropsstringThe name of the ComputeEnvironment.
Default: - generated by CloudFormation
enabledOptionalinherited from ComputeEnvironmentPropsbooleanWhether or not this ComputeEnvironment can accept jobs from a Queue. 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
serviceRoleOptionalinherited from ComputeEnvironmentPropsIRoleThe role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-batch