@aws-cdk_aws-batch-alpha.IComputeEnvironment

interface IComputeEnvironment ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.IComputeEnvironment
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#IComputeEnvironment
Javasoftware.amazon.awscdk.services.batch.alpha.IComputeEnvironment
Pythonaws_cdk.aws_batch_alpha.IComputeEnvironment
TypeScript (source)@aws-cdk/aws-batch-alpha ยป IComputeEnvironment

Implemented by FargateComputeEnvironment, ManagedEc2EcsComputeEnvironment, ManagedEc2EksComputeEnvironment, UnmanagedComputeEnvironment

Represents a ComputeEnvironment.

Properties

NameTypeDescription
computeEnvironmentArn๐Ÿ”นstringThe ARN of this compute environment.
computeEnvironmentName๐Ÿ”นstringThe name of the ComputeEnvironment.
enabled๐Ÿ”นbooleanWhether or not this ComputeEnvironment can accept jobs from a Queue.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.
serviceRole?๐Ÿ”นIRoleThe role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

computeEnvironmentArn๐Ÿ”น

Type: string

The ARN of this compute environment.


computeEnvironmentName๐Ÿ”น

Type: string

The name of the ComputeEnvironment.


enabled๐Ÿ”น

Type: boolean

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.


env๐Ÿ”น

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.


serviceRole?๐Ÿ”น

Type: IRole (optional, default: a serviceRole will be created for managed CEs, none for unmanaged CEs)

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

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

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