Class FargateComputeEnvironment

A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.

Inheritance
object
Resource
FargateComputeEnvironment
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FargateComputeEnvironment : Resource, IFargateComputeEnvironment, IManagedComputeEnvironment, IComputeEnvironment, IResource, IConstruct, IDependable, IEnvironmentAware, IConnectable, ITaggable
Syntax (vb)
Public Class FargateComputeEnvironment Inherits Resource Implements IFargateComputeEnvironment, IManagedComputeEnvironment, IComputeEnvironment, IResource, IConstruct, IDependable, IEnvironmentAware, IConnectable, ITaggable
Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

Examples
IVpc vpc;

             var sharedComputeEnv = new FargateComputeEnvironment(this, "spotEnv", new FargateComputeEnvironmentProps {
                 Vpc = vpc,
                 Spot = true
             });
             var lowPriorityQueue = new JobQueue(this, "JobQueue", new JobQueueProps {
                 Priority = 1
             });
             var highPriorityQueue = new JobQueue(this, "JobQueue", new JobQueueProps {
                 Priority = 10
             });
             lowPriorityQueue.AddComputeEnvironment(sharedComputeEnv, 1);
             highPriorityQueue.AddComputeEnvironment(sharedComputeEnv, 1);

Synopsis

Constructors

FargateComputeEnvironment(Construct, string, IFargateComputeEnvironmentProps)

A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.

Properties

ComputeEnvironmentArn

The ARN of this compute environment.
ComputeEnvironmentName

The name of the ComputeEnvironment.
Connections

The network connections associated with this resource.
Enabled

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

The maximum vCpus this ManagedComputeEnvironment can scale up to.
PROPERTY_INJECTION_ID

Uniquely identifies this class.
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.
ServiceRole

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

Whether or not to use spot instances.
Tags

TagManager to set, remove and format tags.
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.

Methods

FromFargateComputeEnvironmentArn(Construct, string, string)

Reference an existing FargateComputeEnvironment by its arn.

Constructors

FargateComputeEnvironment(Construct, string, IFargateComputeEnvironmentProps)

A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.

public FargateComputeEnvironment(Construct scope, string id, IFargateComputeEnvironmentProps props)
Parameters
scope Construct
id string
props IFargateComputeEnvironmentProps
Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

Examples
IVpc vpc;

             var sharedComputeEnv = new FargateComputeEnvironment(this, "spotEnv", new FargateComputeEnvironmentProps {
                 Vpc = vpc,
                 Spot = true
             });
             var lowPriorityQueue = new JobQueue(this, "JobQueue", new JobQueueProps {
                 Priority = 1
             });
             var highPriorityQueue = new JobQueue(this, "JobQueue", new JobQueueProps {
                 Priority = 10
             });
             lowPriorityQueue.AddComputeEnvironment(sharedComputeEnv, 1);
             highPriorityQueue.AddComputeEnvironment(sharedComputeEnv, 1);

Properties

ComputeEnvironmentArn

The ARN of this compute environment.

public virtual string ComputeEnvironmentArn { get; }
Property Value

string

Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

ComputeEnvironmentName

The name of the ComputeEnvironment.

public virtual string ComputeEnvironmentName { get; }
Property Value

string

Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

Connections

The network connections associated with this resource.

public virtual Connections_ Connections { get; }
Property Value

Connections_

Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

Enabled

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

public virtual 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.

MaxvCpus

The maximum vCpus this ManagedComputeEnvironment can scale up to.

public virtual 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.

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

ReplaceComputeEnvironment

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

public virtual 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:

SecurityGroups

The security groups this Compute Environment will launch instances in.

public virtual ISecurityGroup[] SecurityGroups { get; }
Property Value

ISecurityGroup[]

Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

ServiceRole

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

public virtual IRole? ServiceRole { get; }
Property Value

IRole

Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

Spot

Whether or not to use spot instances.

public virtual 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.

Tags

TagManager to set, remove and format tags.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

TerminateOnUpdate

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

public virtual bool? TerminateOnUpdate { get; }
Property Value

bool?

Remarks

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

UpdateTimeout

Only meaningful if terminateOnUpdate is false.

public virtual 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.

UpdateToLatestImageVersion

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

public virtual 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.

Methods

FromFargateComputeEnvironmentArn(Construct, string, string)

Reference an existing FargateComputeEnvironment by its arn.

public static IFargateComputeEnvironment FromFargateComputeEnvironmentArn(Construct scope, string id, string fargateComputeEnvironmentArn)
Parameters
scope Construct
id string
fargateComputeEnvironmentArn string
Returns

IFargateComputeEnvironment

Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

Implements

Constructs.IConstruct
Constructs.IDependable