A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.
import { FargateComputeEnvironment } from 'aws-cdk-lib/aws-batch';Or use the module namespace:
import * as batch from 'aws-cdk-lib/aws-batch';
// batch.FargateComputeEnvironmentConfiguration passed to the constructor as FargateComputeEnvironmentProps.
ManagedComputeEnvironmentPropsvpcRequiredinherited from ManagedComputeEnvironmentPropsIVpcVPC in which this Compute Environment will launch Instances.
maxvCpusOptionalinherited from ManagedComputeEnvironmentPropsnumberThe 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`.
Default: 256
replaceComputeEnvironmentOptionalinherited from ManagedComputeEnvironmentPropsbooleanSpecifies 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:
Default: false
securityGroupsOptionalinherited from ManagedComputeEnvironmentPropsISecurityGroup[]The security groups this Compute Environment will launch instances in.
Default: new security groups will be created
spotOptionalinherited from ManagedComputeEnvironmentPropsbooleanWhether 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.
Default: false
terminateOnUpdateOptionalinherited from ManagedComputeEnvironmentPropsbooleanWhether 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.
Default: false
updateTimeoutOptionalinherited from ManagedComputeEnvironmentPropsDurationOnly 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.
Default: 30 minutes
updateToLatestImageVersionOptionalinherited from ManagedComputeEnvironmentPropsbooleanWhether 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.
Default: false
vpcSubnetsOptionalinherited from ManagedComputeEnvironmentPropsSubnetSelectionThe VPC Subnets this Compute Environment will launch instances in.
Default: new subnets will be created
ComputeEnvironmentPropscomputeEnvironmentNameOptionalinherited from ComputeEnvironmentPropsstringThe name of the ComputeEnvironment.
Default: - generated by CloudFormation
enabledOptionalinherited from ComputeEnvironmentPropsbooleanWhether 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`.
Default: true
serviceRoleOptionalinherited from ComputeEnvironmentPropsIRoleThe 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
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to Newsletteraws-batch