interface IManagedComputeEnvironment

Language	Type name
.NET	Amazon.CDK.AWS.Batch.IManagedComputeEnvironment
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#IManagedComputeEnvironment
Java	software.amazon.awscdk.services.batch.IManagedComputeEnvironment
Python	aws_cdk.aws_batch.IManagedComputeEnvironment
TypeScript (source)	aws-cdk-lib » aws_batch » IManagedComputeEnvironment

Implemented by FargateComputeEnvironment, ManagedEc2EcsComputeEnvironment, ManagedEc2EksComputeEnvironment

Represents a Managed ComputeEnvironment.

Batch will provision EC2 Instances to meet the requirements of the jobs executing in this ComputeEnvironment.

Properties

Name	Type	Description
computeEnvironmentArn	string	The ARN of this compute environment.
computeEnvironmentName	string	The name of the ComputeEnvironment.
connections	Connections	The network connections associated with this resource.
enabled	boolean	Whether or not this ComputeEnvironment can accept jobs from a Queue.
env	ResourceEnvironment	The environment this resource belongs to.
maxvCpus	number	The maximum vCpus this ManagedComputeEnvironment can scale up to.
node	Node	The tree node.
securityGroups	ISecurityGroup[]	The security groups this Compute Environment will launch instances in.
stack	Stack	The stack in which this resource is defined.
tags	TagManager	TagManager to set, remove and format tags.
replaceComputeEnvironment?	boolean	Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
serviceRole?	IRole	The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
spot?	boolean	Whether or not to use spot instances.
terminateOnUpdate?	boolean	Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.
updateTimeout?	Duration	Only meaningful if terminateOnUpdate is false.
updateToLatestImageVersion?	boolean	Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.
vpcSubnets?	SubnetSelection	The VPC Subnets this Compute Environment will launch instances in.

---

computeEnvironmentArn

Type: string

The ARN of this compute environment.

---

computeEnvironmentName

Type: string

The name of the ComputeEnvironment.

---

connections

Type: Connections

The network connections associated with this resource.

---

enabled

Type: boolean

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

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

maxvCpus

Type: number

The maximum vCpus this ManagedComputeEnvironment can scale up to.

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.

---

node

Type: Node

The tree node.

---

securityGroups

Type: ISecurityGroup[]

The security groups this Compute Environment will launch instances in.

---

stack

Type: Stack

The stack in which this resource is defined.

---

tags

Type: TagManager

TagManager to set, remove and format tags.

---

replaceComputeEnvironment?

Type: boolean (optional)

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

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html

---

serviceRole?

Type: IRole (optional, default: a serviceRole will be created for managed CEs, none for unmanaged CEs)

The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

---

spot?

Type: boolean (optional, default: 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.

---

terminateOnUpdate?

Type: boolean (optional, default: 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.

See also: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

---

updateTimeout?

Type: Duration (optional, default: 30 minutes)

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

See also: https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

---

updateToLatestImageVersion?

Type: boolean (optional, default: 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.

See also: https://github.com/aws/aws-cdk/issues/27054

---

vpcSubnets?

Type: SubnetSelection (optional)

The VPC Subnets this Compute Environment will launch instances in.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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