aws-cdk-lib.aws_batch.IManagedEc2EcsComputeEnvironment

IManagedEc2EcsComputeEnvironment Interface

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

IManagedEc2EcsComputeEnvironment

extends

• IManagedComputeEnvironment

implemented by

• ManagedEc2EcsComputeEnvironment

Source

aws-batch/lib/managed-compute-environment.ts

Type last changed

v2.249.0 · 13 Apr 2026

Properties

allocationStrategy?may be undefinedAllocationStrategyallocation_strategy?may be undefinedAllocationStrategyallocationStrategy?may be undefinedAllocationStrategyAllocationStrategy?may be undefinedAllocationStrategyAllocationStrategy?may be undefinedAllocationStrategy#

The 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.

computeEnvironmentArnstringcompute_environment_arnstrcomputeEnvironmentArnStringComputeEnvironmentArnstringComputeEnvironmentArn*stringrequired#

The ARN of this compute environment.

computeEnvironmentNamestringcompute_environment_namestrcomputeEnvironmentNameStringComputeEnvironmentNamestringComputeEnvironmentName*stringrequired#

The name of the ComputeEnvironment.

computeEnvironmentRefComputeEnvironmentReferencecompute_environment_refComputeEnvironmentReferencecomputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferencerequired#

A reference to a ComputeEnvironment resource.

connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#

The network connections associated with this resource.

enabledbooleanenabledboolenabledBooleanEnabledboolEnabled*boolrequired#

Whether or not this ComputeEnvironment can accept jobs from a Queue.

notes

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.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

images?may be undefinedEcsMachineImage[]images?may be undefinedtyping.List[EcsMachineImage]images?may be undefinedList<EcsMachineImage>Images?may be undefinedEcsMachineImage[]Images?may be undefined*[]EcsMachineImage#

Configure which AMIs this Compute Environment can launch.

Default: ECS_AL2 compatible AMI ids for non-GPU instances, ECS_AL2_NVIDIA compatible AMI ids for GPU instances. If the '@aws-cdk/aws-batch:defaultToAL2023' feature flag is set, ECS_AL2023 will be used instead of ECS_AL2.

Leave this undefined to allow Batch to choose the latest AMIs it supports for each instance that it launches.

instanceClassesInstanceClass[]instance_classestyping.List[InstanceClass]instanceClassesList<InstanceClass>InstanceClassesInstanceClass[]InstanceClasses*[]InstanceClassrequired#

The instance classes that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used. Batch will automatically choose the size.

instanceRole?may be undefinedIRoleinstance_role?may be undefinedIRoleinstanceRole?may be undefinedIRoleInstanceRole?may be undefinedIRoleInstanceRole?may be undefinedIRole#

The execution Role that instances launched by this Compute Environment will use.

Default: a role will be created

instanceTypesInstanceType[]instance_typestyping.List[InstanceType]instanceTypesList<InstanceType>InstanceTypesInstanceType[]InstanceTypes*[]InstanceTyperequired#

The instance types that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.

launchTemplate?may be undefinedILaunchTemplatelaunch_template?may be undefinedILaunchTemplatelaunchTemplate?may be undefinedILaunchTemplateLaunchTemplate?may be undefinedILaunchTemplateLaunchTemplate?may be undefinedILaunchTemplate#

The Launch Template that this Compute Environment will use to provision EC2 Instances.

Default: no launch template

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.

maxvCpusnumbermaxv_cpusint | floatmaxvCpusNumberMaxvCpusdoubleMaxvCpus*float64required#

The maximum vCpus this `ManagedComputeEnvironment` can scale up to.

notes

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.

minvCpus?may be undefinednumberminv_cpus?may be undefinedint | floatminvCpus?may be undefinedNumberMinvCpus?may be undefineddoubleMinvCpus?may be undefined*float64= 0#

The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

placementGroup?may be undefinedIPlacementGroupplacement_group?may be undefinedIPlacementGroupplacementGroup?may be undefinedIPlacementGroupPlacementGroup?may be undefinedIPlacementGroupPlacementGroup?may be undefinedIPlacementGroup#

The EC2 placement group to associate with your compute resources.

Default: no placement group

notes

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.

replaceComputeEnvironment?may be undefinedbooleanreplace_compute_environment?may be undefinedboolreplaceComputeEnvironment?may be undefinedBooleanReplaceComputeEnvironment?may be undefinedboolReplaceComputeEnvironment?may be undefined*bool#

Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.

notes

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:

securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGrouprequired#

The security groups this Compute Environment will launch instances in.

serviceRole?may be undefinedIRoleservice_role?may be undefinedIRoleserviceRole?may be undefinedIRoleServiceRole?may be undefinedIRoleServiceRole?may be undefinedIRole#

The 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

spot?may be undefinedbooleanspot?may be undefinedboolspot?may be undefinedBooleanSpot?may be undefinedboolSpot?may be undefined*bool= false#

Whether 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.

spotBidPercentage?may be undefinednumberspot_bid_percentage?may be undefinedint | floatspotBidPercentage?may be undefinedNumberSpotBidPercentage?may be undefineddoubleSpotBidPercentage?may be undefined*float64= 100%#

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.

notes

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.

spotFleetRole?may be undefinedIRolespot_fleet_role?may be undefinedIRolespotFleetRole?may be undefinedIRoleSpotFleetRole?may be undefinedIRoleSpotFleetRole?may be undefinedIRole#

The service-linked role that Spot Fleet needs to launch instances on your behalf.

Default: a new Role will be created

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManagerrequired#

TagManager to set, remove and format tags.

terminateOnUpdate?may be undefinedbooleanterminate_on_update?may be undefinedboolterminateOnUpdate?may be undefinedBooleanTerminateOnUpdate?may be undefinedboolTerminateOnUpdate?may be undefined*bool= false#

Whether 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.

updateTimeout?may be undefinedDurationupdate_timeout?may be undefinedDurationupdateTimeout?may be undefinedDurationUpdateTimeout?may be undefinedDurationUpdateTimeout?may be undefinedDuration#

Only meaningful if `terminateOnUpdate` is `false`.

Default: 30 minutes

If so, when an infrastructure update is triggered, any running jobs will be allowed to run until updateTimeout has expired.

updateToLatestImageVersion?may be undefinedbooleanupdate_to_latest_image_version?may be undefinedboolupdateToLatestImageVersion?may be undefinedBooleanUpdateToLatestImageVersion?may be undefinedboolUpdateToLatestImageVersion?may be undefined*bool= false#

Whether 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.

useOptimalInstanceClasses?may be undefinedbooleanuse_optimal_instance_classes?may be undefinedbooluseOptimalInstanceClasses?may be undefinedBooleanUseOptimalInstanceClasses?may be undefinedboolUseOptimalInstanceClasses?may be undefined*bool= true#

Whether 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.

vpcSubnets?may be undefinedSubnetSelectionvpc_subnets?may be undefinedSubnetSelectionvpcSubnets?may be undefinedSubnetSelectionVpcSubnets?may be undefinedSubnetSelectionVpcSubnets?may be undefinedSubnetSelection#

The VPC Subnets this Compute Environment will launch instances in.

Methods

addInstanceClass(instanceClass: InstanceClass): voiddef add_instance_class(self, instance_class: InstanceClass) -> Nonepublic void addInstanceClass(InstanceClass instanceClass)public void AddInstanceClass(InstanceClass instanceClass)func AddInstanceClass(InstanceClass InstanceClass)#

Add an instance class to this compute environment.

addInstanceType(instanceType: InstanceType): voiddef add_instance_type(self, instance_type: InstanceType) -> Nonepublic void addInstanceType(InstanceType instanceType)public void AddInstanceType(InstanceType instanceType)func AddInstanceType(InstanceType InstanceType)#

Add an instance type to this compute environment.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining