Interface IComputeEnvironment

Represents a ComputeEnvironment.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Env

IResource.Stack

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IComputeEnvironment : IResource, IConstruct, IDependable

Syntax (vb)

Public Interface IComputeEnvironment Inherits IResource, IConstruct, IDependable

Synopsis

Properties

ComputeEnvironmentArn	The ARN of this compute environment.
ComputeEnvironmentName	The name of the ComputeEnvironment.
Enabled	Whether or not this ComputeEnvironment can accept jobs from a Queue.
ServiceRole	The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

Properties

ComputeEnvironmentArn

The ARN of this compute environment.

string ComputeEnvironmentArn { get; }

Property Value

string

Remarks

Attribute: true

ComputeEnvironmentName

The name of the ComputeEnvironment.

string ComputeEnvironmentName { get; }

Property Value

string

Remarks

Attribute: true

Enabled

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

bool Enabled { get; }

Property Value

bool

Remarks

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.

ServiceRole

The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

IRole? ServiceRole { get; }

Property Value

IRole

Remarks

Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs