Package software.amazon.awscdk.services.batch

Interface IManagedComputeEnvironment.Jsii$Default

All Superinterfaces:

IComputeEnvironment, IComputeEnvironment.Jsii$Default, IComputeEnvironmentRef, IComputeEnvironmentRef.Jsii$Default, IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IManagedComputeEnvironment, IResource, IResource.Jsii$Default, ITaggable, ITaggable.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IFargateComputeEnvironment.Jsii$Default, IManagedEc2EcsComputeEnvironment.Jsii$Default

All Known Implementing Classes:

IFargateComputeEnvironment.Jsii$Proxy, IManagedComputeEnvironment.Jsii$Proxy, IManagedEc2EcsComputeEnvironment.Jsii$Proxy

Enclosing interface:

IManagedComputeEnvironment

@Internal
public static interface IManagedComputeEnvironment.Jsii$Default
extends IManagedComputeEnvironment, ITaggable.Jsii$Default, IComputeEnvironment.Jsii$Default, IConnectable.Jsii$Default

Internal default implementation for IManagedComputeEnvironment.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IComputeEnvironment

IComputeEnvironment.Jsii$Default, IComputeEnvironment.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.batch.IComputeEnvironmentRef

IComputeEnvironmentRef.Jsii$Default, IComputeEnvironmentRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IManagedComputeEnvironment

IManagedComputeEnvironment.Jsii$Default, IManagedComputeEnvironment.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default Number	getMaxvCpus()	The maximum vCpus this ManagedComputeEnvironment can scale up to.
default Boolean	getReplaceComputeEnvironment()	Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
default List<ISecurityGroup>	getSecurityGroups()	The security groups this Compute Environment will launch instances in.
default Boolean	getSpot()	Whether or not to use spot instances.
default Boolean	getTerminateOnUpdate()	Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.
default Duration	getUpdateTimeout()	Only meaningful if terminateOnUpdate is false.
default Boolean	getUpdateToLatestImageVersion()	Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.
default SubnetSelection	getVpcSubnets()	The VPC Subnets this Compute Environment will launch instances in.

Methods inherited from interface software.amazon.awscdk.services.batch.IComputeEnvironment.Jsii$Default

getComputeEnvironmentArn, getComputeEnvironmentName, getEnabled, getServiceRole

Methods inherited from interface software.amazon.awscdk.interfaces.batch.IComputeEnvironmentRef.Jsii$Default

getComputeEnvironmentRef

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable.Jsii$Default

getConnections

Methods inherited from interface software.constructs.IConstruct.Jsii$Default

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware.Jsii$Default

getEnv

Methods inherited from interface software.amazon.awscdk.IResource.Jsii$Default

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.ITaggable.Jsii$Default

getTags

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxvCpus

@Stability(Stable)
@NotNull
default Number getMaxvCpus()

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.

Specified by:

getMaxvCpus in interface IManagedComputeEnvironment

getSecurityGroups

@Stability(Stable)
@NotNull
default List<ISecurityGroup> getSecurityGroups()

The security groups this Compute Environment will launch instances in.

Specified by:

getSecurityGroups in interface IManagedComputeEnvironment

getReplaceComputeEnvironment

@Stability(Stable)
@Nullable
default Boolean getReplaceComputeEnvironment()

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:

Specified by:

getReplaceComputeEnvironment in interface IManagedComputeEnvironment

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html

getSpot

@Stability(Stable)
@Nullable
default Boolean getSpot()

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.

Default: false

Specified by:

getSpot in interface IManagedComputeEnvironment

getTerminateOnUpdate

@Stability(Stable)
@Nullable
default Boolean getTerminateOnUpdate()

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.

Default: false

Specified by:

getTerminateOnUpdate in interface IManagedComputeEnvironment

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

getUpdateTimeout

@Stability(Stable)
@Nullable
default Duration getUpdateTimeout()

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.

Default: 30 minutes

Specified by:

getUpdateTimeout in interface IManagedComputeEnvironment

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html

getUpdateToLatestImageVersion

@Stability(Stable)
@Nullable
default Boolean getUpdateToLatestImageVersion()

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.

Default: false

Specified by:

getUpdateToLatestImageVersion in interface IManagedComputeEnvironment

See Also:

• https://github.com/aws/aws-cdk/issues/27054

getVpcSubnets

@Stability(Stable)
@Nullable
default SubnetSelection getVpcSubnets()

The VPC Subnets this Compute Environment will launch instances in.

Specified by:

getVpcSubnets in interface IManagedComputeEnvironment