ManagedEc2EcsComputeEnvironment L2 construct
A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.
Example
declare const vpc: ec2.IVpc;
const computeEnv = new batch.ManagedEc2EcsComputeEnvironment(this, 'Ec2ComputeEnv', {
vpc,
instanceTypes: [ec2.InstanceType.of(ec2.InstanceClass.M5AD, ec2.InstanceSize.LARGE)],
// useOptimalInstanceClasses: true (default)
});
// Result: ['m5ad.large', 'optimal']
# vpc: ec2.IVpc
compute_env = batch.ManagedEc2EcsComputeEnvironment(self, "Ec2ComputeEnv",
vpc=vpc,
instance_types=[ec2.InstanceType.of(ec2.InstanceClass.M5AD, ec2.InstanceSize.LARGE)]
)
IVpc vpc;
ManagedEc2EcsComputeEnvironment computeEnv = ManagedEc2EcsComputeEnvironment.Builder.create(this, "Ec2ComputeEnv")
.vpc(vpc)
.instanceTypes(List.of(InstanceType.of(InstanceClass.M5AD, InstanceSize.LARGE)))
.build();
// Install: dotnet add package Amazon.CDK.Lib
IVpc vpc;
var computeEnv = new ManagedEc2EcsComputeEnvironment(this, "Ec2ComputeEnv", new ManagedEc2EcsComputeEnvironmentProps {
Vpc = vpc,
InstanceTypes = new [] { InstanceType.Of(InstanceClass.M5AD, InstanceSize.LARGE) }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var vpc IVpc
computeEnv := batch.NewManagedEc2EcsComputeEnvironment(this, jsii.String("Ec2ComputeEnv"), &ManagedEc2EcsComputeEnvironmentProps{
Vpc: Vpc,
InstanceTypes: []InstanceType{
ec2.InstanceType_Of(ec2.InstanceClass_M5AD, ec2.InstanceSize_LARGE),
},
})
Initializer
new ManagedEc2EcsComputeEnvironment(scope: Construct, id: string, props: ManagedEc2EcsComputeEnvironmentProps)
ManagedEc2EcsComputeEnvironment(scope: Construct, id: str, props: ManagedEc2EcsComputeEnvironmentProps)
new ManagedEc2EcsComputeEnvironment(Construct scope, String id, ManagedEc2EcsComputeEnvironmentProps props)
new ManagedEc2EcsComputeEnvironment(Construct scope, string id, ManagedEc2EcsComputeEnvironmentProps props)
NewManagedEc2EcsComputeEnvironment(Scope Construct, Id *string, Props ManagedEc2EcsComputeEnvironmentProps)
Construct Props
allocationStrategyoptionalAllocationStrategyallocation_strategyoptionalAllocationStrategyallocationStrategyoptionalAllocationStrategyAllocationStrategyoptionalAllocationStrategyAllocationStrategyoptionalAllocationStrategy#Default: BEST_FIT_PROGRESSIVE if not using Spot instances, SPOT_PRICE_CAPACITY_OPTIMIZED if using Spot instances.
computeEnvironmentNameoptionalstringcompute_environment_nameoptionalstrcomputeEnvironmentNameoptionalStringComputeEnvironmentNameoptionalstringComputeEnvironmentNameoptional*string#Default: generated by CloudFormation
defaultInstanceClassesoptionalDefaultInstanceClass[]default_instance_classesoptionaltyping.List[DefaultInstanceClass]defaultInstanceClassesoptionalList<DefaultInstanceClass>DefaultInstanceClassesoptionalDefaultInstanceClass[]DefaultInstanceClassesoptional*[]DefaultInstanceClass#Default: choose from instanceTypes and instanceClasses
A simpler way to choose up-to-date instance classes based on region instead of specifying exact instance classes.
enabledoptionalbooleanenabledoptionalboolenabledoptionalBooleanEnabledoptionalboolEnabledoptional*bool= true#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.
imagesoptionalEcsMachineImage[]imagesoptionaltyping.List[EcsMachineImage]imagesoptionalList<EcsMachineImage>ImagesoptionalEcsMachineImage[]Imagesoptional*[]EcsMachineImage#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.
notes
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.
instanceClassesoptionalInstanceClass[]instance_classesoptionaltyping.List[InstanceClass]instanceClassesoptionalList<InstanceClass>InstanceClassesoptionalInstanceClass[]InstanceClassesoptional*[]InstanceClass#Default: the instances Batch considers will be used (currently C4, M4, and R4)
Which one is chosen depends on the AllocationStrategy used. Batch will automatically choose the instance size.
instanceRoleoptionalIRoleinstance_roleoptionalIRoleinstanceRoleoptionalIRoleInstanceRoleoptionalIRoleInstanceRoleoptionalIRole#Default: a role will be created
instanceTypesoptionalInstanceType[]instance_typesoptionaltyping.List[InstanceType]instanceTypesoptionalList<InstanceType>InstanceTypesoptionalInstanceType[]InstanceTypesoptional*[]InstanceType#Default: the instances Batch considers will be used (currently C4, M4, and R4)
Which one is chosen depends on the AllocationStrategy used.
launchTemplateoptionalILaunchTemplatelaunch_templateoptionalILaunchTemplatelaunchTemplateoptionalILaunchTemplateLaunchTemplateoptionalILaunchTemplateLaunchTemplateoptionalILaunchTemplate#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.
maxvCpusoptionalnumbermaxv_cpusoptionalint | floatmaxvCpusoptionalNumberMaxvCpusoptionaldoubleMaxvCpusoptional*float64= 256#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.
minvCpusoptionalnumberminv_cpusoptionalint | floatminvCpusoptionalNumberMinvCpusoptionaldoubleMinvCpusoptional*float64= 0#placementGroupoptionalIPlacementGroupRefplacement_groupoptionalIPlacementGroupRefplacementGroupoptionalIPlacementGroupRefPlacementGroupoptionalIPlacementGroupRefPlacementGroupoptionalIPlacementGroupRef#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.
replaceComputeEnvironmentoptionalbooleanreplace_compute_environmentoptionalboolreplaceComputeEnvironmentoptionalBooleanReplaceComputeEnvironmentoptionalboolReplaceComputeEnvironmentoptional*bool= false#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:
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#Default: new security groups will be created
serviceRoleoptionalIRoleservice_roleoptionalIRoleserviceRoleoptionalIRoleServiceRoleoptionalIRoleServiceRoleoptionalIRole#Default: a serviceRole will be created for managed CEs, none for unmanaged CEs
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.
spotBidPercentageoptionalnumberspot_bid_percentageoptionalint | floatspotBidPercentageoptionalNumberSpotBidPercentageoptionaldoubleSpotBidPercentageoptional*float64= 100%#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.
Implies spot == true if set
spotFleetRoleoptionalIRolespot_fleet_roleoptionalIRolespotFleetRoleoptionalIRoleSpotFleetRoleoptionalIRoleSpotFleetRoleoptionalIRole#Default: a new role will be created
terminateOnUpdateoptionalbooleanterminate_on_updateoptionalboolterminateOnUpdateoptionalBooleanTerminateOnUpdateoptionalboolTerminateOnUpdateoptional*bool= false#If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.
updateTimeoutoptionalDurationupdate_timeoutoptionalDurationupdateTimeoutoptionalDurationUpdateTimeoutoptionalDurationUpdateTimeoutoptionalDuration#Default: 30 minutes
If so, when an infrastructure update is triggered, any running jobs will be allowed to run until updateTimeout has expired.
updateToLatestImageVersionoptionalbooleanupdate_to_latest_image_versionoptionalboolupdateToLatestImageVersionoptionalBooleanUpdateToLatestImageVersionoptionalboolUpdateToLatestImageVersionoptional*bool= false#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.
useOptimalInstanceClassesoptionalbooleanuse_optimal_instance_classesoptionalbooluseOptimalInstanceClassesoptionalBooleanUseOptimalInstanceClassesoptionalboolUseOptimalInstanceClassesoptional*bool= true#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.
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#Default: new subnets will be created
Properties
allocationStrategymay be undefinedAllocationStrategyallocation_strategymay be undefinedAllocationStrategyallocationStrategymay be undefinedAllocationStrategyAllocationStrategymay be undefinedAllocationStrategyAllocationStrategymay be undefinedAllocationStrategy#computeEnvironmentArnstringcompute_environment_arnstrcomputeEnvironmentArnStringComputeEnvironmentArnstringComputeEnvironmentArn*string#computeEnvironmentNamestringcompute_environment_namestrcomputeEnvironmentNameStringComputeEnvironmentNamestringComputeEnvironmentName*string#computeEnvironmentRefComputeEnvironmentReferencecompute_environment_refComputeEnvironmentReferencecomputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReference#connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnections#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.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#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.
imagesmay be undefinedEcsMachineImage[]imagesmay be undefinedtyping.List[EcsMachineImage]imagesmay be undefinedList<EcsMachineImage>Imagesmay be undefinedEcsMachineImage[]Imagesmay be undefined*[]EcsMachineImage#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*[]InstanceClass#Which one is chosen depends on the AllocationStrategy used.
instanceRolemay be undefinedIRoleinstance_rolemay be undefinedIRoleinstanceRolemay be undefinedIRoleInstanceRolemay be undefinedIRoleInstanceRolemay be undefinedIRole#instanceTypesInstanceType[]instance_typestyping.List[InstanceType]instanceTypesList<InstanceType>InstanceTypesInstanceType[]InstanceTypes*[]InstanceType#Which one is chosen depends on the AllocationStrategy used.
launchTemplatemay be undefinedILaunchTemplatelaunch_templatemay be undefinedILaunchTemplatelaunchTemplatemay be undefinedILaunchTemplateLaunchTemplatemay be undefinedILaunchTemplateLaunchTemplatemay be undefinedILaunchTemplate#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.
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.
minvCpusmay be undefinednumberminv_cpusmay be undefinedint | floatminvCpusmay be undefinedNumberMinvCpusmay be undefineddoubleMinvCpusmay be undefined*float64#placementGroupmay be undefinedIPlacementGroupplacement_groupmay be undefinedIPlacementGroupplacementGroupmay be undefinedIPlacementGroupPlacementGroupmay be undefinedIPlacementGroupPlacementGroupmay be undefinedIPlacementGroup#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.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#replaceComputeEnvironmentmay be undefinedbooleanreplace_compute_environmentmay be undefinedboolreplaceComputeEnvironmentmay be undefinedBooleanReplaceComputeEnvironmentmay be undefinedboolReplaceComputeEnvironmentmay be undefined*bool#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*[]ISecurityGroup#serviceRolemay be undefinedIRoleservice_rolemay be undefinedIRoleserviceRolemay be undefinedIRoleServiceRolemay be undefinedIRoleServiceRolemay be undefinedIRole#spotmay be undefinedbooleanspotmay be undefinedboolspotmay be undefinedBooleanSpotmay be undefinedboolSpotmay be undefined*bool#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.
spotBidPercentagemay be undefinednumberspot_bid_percentagemay be undefinedint | floatspotBidPercentagemay be undefinedNumberSpotBidPercentagemay be undefineddoubleSpotBidPercentagemay be undefined*float64#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.
spotFleetRolemay be undefinedIRolespot_fleet_rolemay be undefinedIRolespotFleetRolemay be undefinedIRoleSpotFleetRolemay be undefinedIRoleSpotFleetRolemay be undefinedIRole#terminateOnUpdatemay be undefinedbooleanterminate_on_updatemay be undefinedboolterminateOnUpdatemay be undefinedBooleanTerminateOnUpdatemay be undefinedboolTerminateOnUpdatemay be undefined*bool#If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.
updateTimeoutmay be undefinedDurationupdate_timeoutmay be undefinedDurationupdateTimeoutmay be undefinedDurationUpdateTimeoutmay be undefinedDurationUpdateTimeoutmay be undefinedDuration#If so, when an infrastructure update is triggered, any running jobs will be allowed to run until updateTimeout has expired.
updateToLatestImageVersionmay be undefinedbooleanupdate_to_latest_image_versionmay be undefinedboolupdateToLatestImageVersionmay be undefinedBooleanUpdateToLatestImageVersionmay be undefinedboolUpdateToLatestImageVersionmay be undefined*bool#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.
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)#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)#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#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).
fromManagedEc2EcsComputeEnvironmentArn(scope: Construct, id: string, managedEc2EcsComputeEnvironmentArn: string): IManagedEc2EcsComputeEnvironment@staticmethod def from_managed_ec2_ecs_compute_environment_arn(scope: Construct, id: str, managed_ec2_ecs_compute_environment_arn: str) -> IManagedEc2EcsComputeEnvironmentpublic static IManagedEc2EcsComputeEnvironment fromManagedEc2EcsComputeEnvironmentArn(Construct scope, String id, String managedEc2EcsComputeEnvironmentArn)public static IManagedEc2EcsComputeEnvironment FromManagedEc2EcsComputeEnvironmentArn(Construct scope, string id, string managedEc2EcsComputeEnvironmentArn)func FromManagedEc2EcsComputeEnvironmentArn(Scope Construct, Id *string, ManagedEc2EcsComputeEnvironmentArn *string) IManagedEc2EcsComputeEnvironmentstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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. Use multiple with() calls if subsequent mixins should apply to added constructs.