Interface IManagedComputeEnvironment

Represents a Managed ComputeEnvironment.

Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IManagedComputeEnvironment : IComputeEnvironment, IResource, IComputeEnvironmentRef, IConstruct, IDependable, IEnvironmentAware, IConnectable, ITaggable
Syntax (vb)
Public Interface IManagedComputeEnvironment Inherits IComputeEnvironment, IResource, IComputeEnvironmentRef, IConstruct, IDependable, IEnvironmentAware, IConnectable, ITaggable
Remarks

Batch will provision EC2 Instances to meet the requirements of the jobs executing in this ComputeEnvironment.

Synopsis

Properties

MaxvCpus

The maximum vCpus this ManagedComputeEnvironment can scale up to.
ReplaceComputeEnvironment

Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
SecurityGroups

The security groups this Compute Environment will launch instances in.
Spot

Whether or not to use spot instances.
TerminateOnUpdate

Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.
UpdateTimeout

Only meaningful if terminateOnUpdate is false.
UpdateToLatestImageVersion

Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.
VpcSubnets

The VPC Subnets this Compute Environment will launch instances in.

Properties

MaxvCpus

The maximum vCpus this ManagedComputeEnvironment can scale up to.

double MaxvCpus { get; }
Property Value

double

Remarks

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.

ReplaceComputeEnvironment

Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.

bool? ReplaceComputeEnvironment { get; }
Property Value

bool?

Remarks

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:

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

SecurityGroups

The security groups this Compute Environment will launch instances in.

ISecurityGroup[] SecurityGroups { get; }
Property Value

ISecurityGroup[]

Remarks

Batch will provision EC2 Instances to meet the requirements of the jobs executing in this ComputeEnvironment.

Spot

Whether or not to use spot instances.

bool? Spot { get; }
Property Value

bool?

Remarks

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

TerminateOnUpdate

Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.

bool? TerminateOnUpdate { get; }
Property Value

bool?

Remarks

If this is enabled, any terminated jobs may be retried, depending on the job's retry policy.

Default: false

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

UpdateTimeout

Only meaningful if terminateOnUpdate is false.

Duration? UpdateTimeout { get; }
Property Value

Duration

Remarks

If so, when an infrastructure update is triggered, any running jobs will be allowed to run until updateTimeout has expired.

Default: 30 minutes

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

UpdateToLatestImageVersion

Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs.

bool? UpdateToLatestImageVersion { get; }
Property Value

bool?

Remarks

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

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

VpcSubnets

The VPC Subnets this Compute Environment will launch instances in.

ISubnetSelection? VpcSubnets { get; }
Property Value

ISubnetSelection

Remarks

Batch will provision EC2 Instances to meet the requirements of the jobs executing in this ComputeEnvironment.