IManagedEc2EcsComputeEnvironment Interface
A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.
Properties
allocationStrategyAllocationStrategyallocation_strategyAllocationStrategyallocationStrategyAllocationStrategyAllocationStrategyAllocationStrategyAllocationStrategyAllocationStrategy#Default: BEST_FIT_PROGRESSIVE if not using Spot instances, SPOT_PRICE_CAPACITY_OPTIMIZED if using Spot instances.
computeEnvironmentArnstringcompute_environment_arnstrcomputeEnvironmentArnStringComputeEnvironmentArnstringComputeEnvironmentArn*stringrequired#computeEnvironmentNamestringcompute_environment_namestrcomputeEnvironmentNameStringComputeEnvironmentNamestringComputeEnvironmentName*stringrequired#computeEnvironmentRefComputeEnvironmentReferencecompute_environment_refComputeEnvironmentReferencecomputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferencerequired#connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#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#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.
imagesEcsMachineImage[]imagestyping.List[EcsMachineImage]imagesList<EcsMachineImage>ImagesEcsMachineImage[]Images*[]EcsMachineImage#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#Which one is chosen depends on the AllocationStrategy used. Batch will automatically choose the size.
Default: a role will be created
instanceTypesInstanceType[]instance_typestyping.List[InstanceType]instanceTypesList<InstanceType>InstanceTypesInstanceType[]InstanceTypes*[]InstanceTyperequired#Which one is chosen depends on the AllocationStrategy used.
launchTemplateILaunchTemplatelaunch_templateILaunchTemplatelaunchTemplateILaunchTemplateLaunchTemplateILaunchTemplateLaunchTemplateILaunchTemplate#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.
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.
placementGroupIPlacementGroupplacement_groupIPlacementGroupplacementGroupIPlacementGroupPlacementGroupIPlacementGroupPlacementGroupIPlacementGroup#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.
replaceComputeEnvironmentbooleanreplace_compute_environmentboolreplaceComputeEnvironmentBooleanReplaceComputeEnvironmentboolReplaceComputeEnvironment*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*[]ISecurityGrouprequired#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.
spotBidPercentagenumberspot_bid_percentageint | floatspotBidPercentageNumberSpotBidPercentagedoubleSpotBidPercentage*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.
Default: a new Role will be created
terminateOnUpdatebooleanterminate_on_updateboolterminateOnUpdateBooleanTerminateOnUpdateboolTerminateOnUpdate*bool= false#If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.
updateTimeoutDurationupdate_timeoutDurationupdateTimeoutDurationUpdateTimeoutDurationUpdateTimeoutDuration#Default: 30 minutes
If so, when an infrastructure update is triggered, any running jobs will be allowed to run until updateTimeout has expired.
updateToLatestImageVersionbooleanupdate_to_latest_image_versionboolupdateToLatestImageVersionBooleanUpdateToLatestImageVersionboolUpdateToLatestImageVersion*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.
useOptimalInstanceClassesbooleanuse_optimal_instance_classesbooluseOptimalInstanceClassesBooleanUseOptimalInstanceClassesboolUseOptimalInstanceClasses*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.
vpcSubnetsSubnetSelectionvpc_subnetsSubnetSelectionvpcSubnetsSubnetSelectionVpcSubnetsSubnetSelectionVpcSubnetsSubnetSelection#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)#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).
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.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining