@aws-cdk_aws-batch-alpha.UnmanagedComputeEnvironment

class UnmanagedComputeEnvironment (construct) ๐Ÿ”น

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

Implements IConstruct, IDependable, IResource, IUnmanagedComputeEnvironment, IComputeEnvironment

Unmanaged ComputeEnvironments do not provision or manage EC2 instances on your behalf.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as batch_alpha from '@aws-cdk/aws-batch-alpha';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const role: iam.Role;
const unmanagedComputeEnvironment = new batch_alpha.UnmanagedComputeEnvironment(this, 'MyUnmanagedComputeEnvironment', /* all optional props */ {
  computeEnvironmentName: 'computeEnvironmentName',
  enabled: false,
  serviceRole: role,
  unmanagedvCpus: 123,
});

Initializer

new UnmanagedComputeEnvironment(scope: Construct, id: string, props?: UnmanagedComputeEnvironmentProps)

Parameters

  • scope Construct
  • id string
  • props UnmanagedComputeEnvironmentProps

Construct Props

NameTypeDescription
computeEnvironmentName?๐Ÿ”นstringThe name of the ComputeEnvironment.
enabled?๐Ÿ”นbooleanWhether or not this ComputeEnvironment can accept jobs from a Queue.
serviceRole?๐Ÿ”นIRoleThe role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
unmanagedvCpus?๐Ÿ”นnumberThe vCPUs this Compute Environment provides. Used only by the scheduler to schedule jobs in Queues that use FairshareSchedulingPolicys.

computeEnvironmentName?๐Ÿ”น

Type: string (optional, default: generated by CloudFormation)

The name of the ComputeEnvironment.


enabled?๐Ÿ”น

Type: boolean (optional, default: true)

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.


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.


unmanagedvCpus?๐Ÿ”น

Type: number (optional, default: 0)

The vCPUs this Compute Environment provides. Used only by the scheduler to schedule jobs in Queues that use FairshareSchedulingPolicys.

If this parameter is not provided on a fairshare queue, no capacity is reserved; that is, the FairshareSchedulingPolicy is ignored.

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.
unmanagedvCPUs?๐Ÿ”นnumberThe vCPUs this Compute Environment provides. Used only by the scheduler to schedule jobs in Queues that use FairshareSchedulingPolicys.

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)

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


unmanagedvCPUs?๐Ÿ”น

Type: number (optional)

The vCPUs this Compute Environment provides. Used only by the scheduler to schedule jobs in Queues that use FairshareSchedulingPolicys.

If this parameter is not provided on a fairshare queue, no capacity is reserved; that is, the FairshareSchedulingPolicy is ignored.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
toString()๐Ÿ”นReturns a string representation of this construct.
static fromUnmanagedComputeEnvironmentArn(scope, id, unmanagedComputeEnvironmentArn)๐Ÿ”นImport an UnmanagedComputeEnvironment by its arn.

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


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromUnmanagedComputeEnvironmentArn(scope, id, unmanagedComputeEnvironmentArn)๐Ÿ”น

public static fromUnmanagedComputeEnvironmentArn(scope: Construct, id: string, unmanagedComputeEnvironmentArn: string): IUnmanagedComputeEnvironment

Parameters

  • scope Construct
  • id string
  • unmanagedComputeEnvironmentArn string

Returns

  • IUnmanagedComputeEnvironment

Import an UnmanagedComputeEnvironment by its arn.