aws-cdk-lib.aws_batch.IFargateComputeEnvironment

IFargateComputeEnvironment Interface

A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.

IFargateComputeEnvironment

extends

• IManagedComputeEnvironment

implemented by

• FargateComputeEnvironment

Source

aws-batch/lib/managed-compute-environment.ts

Type last changed

v2.96.0 · 13 Sep 2023

Properties

computeEnvironmentArnstringcompute_environment_arnstrcomputeEnvironmentArnStringComputeEnvironmentArnstringComputeEnvironmentArn*stringrequired#

The ARN of this compute environment.

computeEnvironmentNamestringcompute_environment_namestrcomputeEnvironmentNameStringComputeEnvironmentNamestringComputeEnvironmentName*stringrequired#

The name of the ComputeEnvironment.

computeEnvironmentRefComputeEnvironmentReferencecompute_environment_refComputeEnvironmentReferencecomputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferenceComputeEnvironmentRefComputeEnvironmentReferencerequired#

A reference to a ComputeEnvironment resource.

connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#

The network connections associated with this resource.

enabledbooleanenabledboolenabledBooleanEnabledboolEnabled*boolrequired#

Whether or not this ComputeEnvironment can accept jobs from a Queue.

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#

The environment this resource belongs to.

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.

maxvCpusnumbermaxv_cpusint | floatmaxvCpusNumberMaxvCpusdoubleMaxvCpus*float64required#

The maximum vCpus this `ManagedComputeEnvironment` can scale up to.

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

replaceComputeEnvironment?may be undefinedbooleanreplace_compute_environment?may be undefinedboolreplaceComputeEnvironment?may be undefinedBooleanReplaceComputeEnvironment?may be undefinedboolReplaceComputeEnvironment?may be undefined*bool#

Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.

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#

The security groups this Compute Environment will launch instances in.

serviceRole?may be undefinedIRoleservice_role?may be undefinedIRoleserviceRole?may be undefinedIRoleServiceRole?may be undefinedIRoleServiceRole?may be undefinedIRole#

The 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

spot?may be undefinedbooleanspot?may be undefinedboolspot?may be undefinedBooleanSpot?may be undefinedboolSpot?may be undefined*bool= 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.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManagerrequired#

TagManager to set, remove and format tags.

terminateOnUpdate?may be undefinedbooleanterminate_on_update?may be undefinedboolterminateOnUpdate?may be undefinedBooleanTerminateOnUpdate?may be undefinedboolTerminateOnUpdate?may be undefined*bool= 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.

updateTimeout?may be undefinedDurationupdate_timeout?may be undefinedDurationupdateTimeout?may be undefinedDurationUpdateTimeout?may be undefinedDurationUpdateTimeout?may be undefinedDuration#

Only meaningful if `terminateOnUpdate` is `false`.

Default: 30 minutes

If so, when an infrastructure update is triggered, any running jobs will be allowed to run until updateTimeout has expired.

updateToLatestImageVersion?may be undefinedbooleanupdate_to_latest_image_version?may be undefinedboolupdateToLatestImageVersion?may be undefinedBooleanUpdateToLatestImageVersion?may be undefinedboolUpdateToLatestImageVersion?may be undefined*bool= 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.

vpcSubnets?may be undefinedSubnetSelectionvpc_subnets?may be undefinedSubnetSelectionvpcSubnets?may be undefinedSubnetSelectionVpcSubnets?may be undefinedSubnetSelectionVpcSubnets?may be undefinedSubnetSelection#

The VPC Subnets this Compute Environment will launch instances in.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

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#

Applies one or more mixins to this construct.

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