Package software.amazon.awscdk.services.batch

Interface IComputeEnvironment

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IComputeEnvironment.Jsii$Default, IFargateComputeEnvironment, IFargateComputeEnvironment.Jsii$Default, IManagedComputeEnvironment, IManagedComputeEnvironment.Jsii$Default, IManagedEc2EcsComputeEnvironment, IManagedEc2EcsComputeEnvironment.Jsii$Default, IUnmanagedComputeEnvironment, IUnmanagedComputeEnvironment.Jsii$Default

All Known Implementing Classes:

FargateComputeEnvironment, IComputeEnvironment.Jsii$Proxy, IFargateComputeEnvironment.Jsii$Proxy, IManagedComputeEnvironment.Jsii$Proxy, IManagedEc2EcsComputeEnvironment.Jsii$Proxy, IUnmanagedComputeEnvironment.Jsii$Proxy, ManagedEc2EcsComputeEnvironment, ManagedEc2EksComputeEnvironment, UnmanagedComputeEnvironment

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:12.029Z")
@Stability(Stable)
public interface IComputeEnvironment
extends software.amazon.jsii.JsiiSerializable, IResource

Represents a ComputeEnvironment.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IComputeEnvironment.Jsii$Default	Internal default implementation for IComputeEnvironment.
static final class	IComputeEnvironment.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getComputeEnvironmentArn()	The ARN of this compute environment.
String	getComputeEnvironmentName()	The name of the ComputeEnvironment.
Boolean	getEnabled()	Whether or not this ComputeEnvironment can accept jobs from a Queue.
default IRole	getServiceRole()	The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputeEnvironmentArn

@Stability(Stable)
@NotNull
String getComputeEnvironmentArn()

The ARN of this compute environment.

getComputeEnvironmentName

@Stability(Stable)
@NotNull
String getComputeEnvironmentName()

The name of the ComputeEnvironment.

getEnabled

@Stability(Stable)
@NotNull
Boolean getEnabled()

Whether 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.

getServiceRole

@Stability(Stable)
@Nullable
default IRole getServiceRole()

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