@aws-cdk_aws-batch-alpha.ManagedEc2EcsComputeEnvironment

class ManagedEc2EcsComputeEnvironment (construct) ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.ManagedEc2EcsComputeEnvironment
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#ManagedEc2EcsComputeEnvironment
Javasoftware.amazon.awscdk.services.batch.alpha.ManagedEc2EcsComputeEnvironment
Pythonaws_cdk.aws_batch_alpha.ManagedEc2EcsComputeEnvironment
TypeScript (source)@aws-cdk/aws-batch-alpha ยป ManagedEc2EcsComputeEnvironment

Implements IConstruct, IDependable, IResource, IManagedEc2EcsComputeEnvironment, IComputeEnvironment, IConnectable, ITaggable, IManagedComputeEnvironment

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

Example

const vpc = new ec2.Vpc(this, 'VPC');

declare const computeEnv: batch.IManagedEc2EcsComputeEnvironment
computeEnv.addInstanceClass(ec2.InstanceClass.M5AD);
// Or, specify it on the constructor:
new batch.ManagedEc2EcsComputeEnvironment(this, 'myEc2ComputeEnv', {
  vpc,
  instanceClasses: [ec2.InstanceClass.R4],
});

Initializer

new ManagedEc2EcsComputeEnvironment(scope: Construct, id: string, props: ManagedEc2EcsComputeEnvironmentProps)

Parameters

  • scope Construct
  • id string
  • props ManagedEc2EcsComputeEnvironmentProps

Construct Props

NameTypeDescription
vpc๐Ÿ”นIVpcVPC in which this Compute Environment will launch Instances.
allocationStrategy?๐Ÿ”นAllocationStrategyThe allocation strategy to use if not enough instances of the best fitting instance type can be allocated.
computeEnvironmentName?๐Ÿ”นstringThe name of the ComputeEnvironment.
enabled?๐Ÿ”นbooleanWhether or not this ComputeEnvironment can accept jobs from a Queue.
images?๐Ÿ”นEcsMachineImage[]Configure which AMIs this Compute Environment can launch.
instanceClasses?๐Ÿ”นInstanceClass[]The instance classes that this Compute Environment can launch.
instanceRole?๐Ÿ”นIRoleThe execution Role that instances launched by this Compute Environment will use.
instanceTypes?๐Ÿ”นInstanceType[]The instance types that this Compute Environment can launch.
launchTemplate?๐Ÿ”นILaunchTemplateThe Launch Template that this Compute Environment will use to provision EC2 Instances.
maxvCpus?๐Ÿ”นnumberThe maximum vCpus this ManagedComputeEnvironment can scale up to. Each vCPU is equivalent to 1024 CPU shares.
minvCpus?๐Ÿ”นnumberThe minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.
placementGroup?๐Ÿ”นIPlacementGroupThe EC2 placement group to associate with your compute resources.
replaceComputeEnvironment?๐Ÿ”นbooleanSpecifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
securityGroups?๐Ÿ”นISecurityGroup[]The security groups this Compute Environment will launch instances in.
serviceRole?๐Ÿ”นIRoleThe role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
spot?๐Ÿ”นbooleanWhether or not to use spot instances.
spotBidPercentage?๐Ÿ”นnumberThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.
spotFleetRole?๐Ÿ”นIRoleThe service-linked role that Spot Fleet needs to launch instances on your behalf.
terminateOnUpdate?๐Ÿ”นbooleanWhether or not any running jobs will be immediately terminated when an infrastructure update occurs.
updateTimeout?๐Ÿ”นDurationOnly meaningful if terminateOnUpdate is false.
updateToLatestImageVersion?๐Ÿ”นbooleanWhether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.
useOptimalInstanceClasses?๐Ÿ”นbooleanWhether or not to use batch's optimal instance type.
vpcSubnets?๐Ÿ”นSubnetSelectionThe VPC Subnets this Compute Environment will launch instances in.

vpc๐Ÿ”น

Type: IVpc

VPC in which this Compute Environment will launch Instances.


allocationStrategy?๐Ÿ”น

Type: AllocationStrategy (optional, default: BEST_FIT_PROGRESSIVE if not using Spot instances, SPOT_CAPACITY_OPTIMIZED if using Spot instances.)

The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.


computeEnvironmentName?๐Ÿ”น

Type: string (optional, default: generated by CloudFormation)

The name of the ComputeEnvironment.


enabled?๐Ÿ”น

Type: boolean (optional, default: true)

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.


images?๐Ÿ”น

Type: EcsMachineImage[] (optional, default: ECS_AL2 for non-GPU instances, ECS_AL2_NVIDIA for GPU instances)

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. If your image needs GPU resources, specify ECS_AL2_NVIDIA; otherwise, the instances will not be able to properly join the ComputeEnvironment.


instanceClasses?๐Ÿ”น

Type: InstanceClass[] (optional, default: the instances Batch considers will be used (currently C4, M4, and R4))

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.


instanceRole?๐Ÿ”น

Type: IRole (optional, default: a role will be created)

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


instanceTypes?๐Ÿ”น

Type: InstanceType[] (optional, default: the instances Batch considers will be used (currently C4, M4, and R4))

The instance types that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.


launchTemplate?๐Ÿ”น

Type: ILaunchTemplate (optional, default: no launch template)

The 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 securityGroups on the Compute Environment override the ones on the launch template.


maxvCpus?๐Ÿ”น

Type: number (optional, default: 256)

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


minvCpus?๐Ÿ”น

Type: number (optional, default: 0)

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


placementGroup?๐Ÿ”น

Type: IPlacementGroup (optional, default: no placement group)

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

See also: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html


replaceComputeEnvironment?๐Ÿ”น

Type: boolean (optional, default: false)

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


securityGroups?๐Ÿ”น

Type: ISecurityGroup[] (optional, default: new security groups will be created)

The security groups this Compute Environment will launch instances in.


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.


spotBidPercentage?๐Ÿ”น

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

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


spotFleetRole?๐Ÿ”น

Type: IRole (optional, default: a new role will be created)

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

See also: https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html


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: true)

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.


useOptimalInstanceClasses?๐Ÿ”น

Type: boolean (optional, default: 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?๐Ÿ”น

Type: SubnetSelection (optional, default: new subnets will be created)

The VPC Subnets this Compute Environment will launch instances in.

Properties

NameTypeDescription
computeEnvironmentArn๐Ÿ”นstringThe ARN of this compute environment.
computeEnvironmentName๐Ÿ”นstringThe name of the ComputeEnvironment.
connections๐Ÿ”นConnectionsThe network connections associated with this resource.
enabled๐Ÿ”นbooleanWhether or not this ComputeEnvironment can accept jobs from a Queue.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
instanceClasses๐Ÿ”นInstanceClass[]The instance classes that this Compute Environment can launch.
instanceTypes๐Ÿ”นInstanceType[]The instance types that this Compute Environment can launch.
maxvCpus๐Ÿ”นnumberThe maximum vCpus this ManagedComputeEnvironment can scale up to.
node๐Ÿ”นNodeThe tree node.
securityGroups๐Ÿ”นISecurityGroup[]The security groups this Compute Environment will launch instances in.
stack๐Ÿ”นStackThe stack in which this resource is defined.
tags๐Ÿ”นTagManagerTagManager to set, remove and format tags.
allocationStrategy?๐Ÿ”นAllocationStrategyThe allocation strategy to use if not enough instances of the best fitting instance type can be allocated.
images?๐Ÿ”นEcsMachineImage[]Configure which AMIs this Compute Environment can launch.
instanceRole?๐Ÿ”นIRoleThe execution Role that instances launched by this Compute Environment will use.
launchTemplate?๐Ÿ”นILaunchTemplateThe Launch Template that this Compute Environment will use to provision EC2 Instances.
minvCpus?๐Ÿ”นnumberThe minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.
placementGroup?๐Ÿ”นIPlacementGroupThe EC2 placement group to associate with your compute resources.
replaceComputeEnvironment?๐Ÿ”นbooleanSpecifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
serviceRole?๐Ÿ”นIRoleThe role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
spot?๐Ÿ”นbooleanWhether or not to use spot instances.
spotBidPercentage?๐Ÿ”นnumberThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.
spotFleetRole?๐Ÿ”นIRoleThe service-linked role that Spot Fleet needs to launch instances on your behalf.
terminateOnUpdate?๐Ÿ”นbooleanWhether or not any running jobs will be immediately terminated when an infrastructure update occurs.
updateTimeout?๐Ÿ”นDurationOnly meaningful if terminateOnUpdate is false.
updateToLatestImageVersion?๐Ÿ”นbooleanWhether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.

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.


instanceClasses๐Ÿ”น

Type: InstanceClass[]

The instance classes that this Compute Environment can launch.

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


instanceTypes๐Ÿ”น

Type: InstanceType[]

The instance types that this Compute Environment can launch.

Which one is chosen depends on the AllocationStrategy used.


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.


allocationStrategy?๐Ÿ”น

Type: AllocationStrategy (optional)

The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.


images?๐Ÿ”น

Type: EcsMachineImage[] (optional)

Configure which AMIs this Compute Environment can launch.

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


instanceRole?๐Ÿ”น

Type: IRole (optional)

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


launchTemplate?๐Ÿ”น

Type: ILaunchTemplate (optional)

The 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 securityGroups on the Compute Environment override the ones on the launch template.


minvCpus?๐Ÿ”น

Type: number (optional)

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


placementGroup?๐Ÿ”น

Type: IPlacementGroup (optional)

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


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:


serviceRole?๐Ÿ”น

Type: IRole (optional)

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)

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?๐Ÿ”น

Type: number (optional)

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.

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?๐Ÿ”น

Type: IRole (optional)

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


terminateOnUpdate?๐Ÿ”น

Type: boolean (optional)

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?๐Ÿ”น

Type: Duration (optional)

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.


updateToLatestImageVersion?๐Ÿ”น

Type: boolean (optional)

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.

Methods

NameDescription
addInstanceClass(instanceClass)๐Ÿ”นAdd an instance class to this compute environment.
addInstanceType(instanceType)๐Ÿ”นAdd an instance type to this compute environment.
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
toString()๐Ÿ”นReturns a string representation of this construct.
static fromManagedEc2EcsComputeEnvironmentArn(scope, id, managedEc2EcsComputeEnvironmentArn)๐Ÿ”นrefer to an existing ComputeEnvironment by its arn.

addInstanceClass(instanceClass)๐Ÿ”น

public addInstanceClass(instanceClass: InstanceClass): void

Parameters

  • instanceClass InstanceClass

Add an instance class to this compute environment.


addInstanceType(instanceType)๐Ÿ”น

public addInstanceType(instanceType: InstanceType): void

Parameters

  • instanceType InstanceType

Add an instance type to this compute environment.


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


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromManagedEc2EcsComputeEnvironmentArn(scope, id, managedEc2EcsComputeEnvironmentArn)๐Ÿ”น

public static fromManagedEc2EcsComputeEnvironmentArn(scope: Construct, id: string, managedEc2EcsComputeEnvironmentArn: string): IManagedEc2EcsComputeEnvironment

Parameters

  • scope Construct
  • id string
  • managedEc2EcsComputeEnvironmentArn string

Returns

  • IManagedEc2EcsComputeEnvironment

refer to an existing ComputeEnvironment by its arn.