Class ManagedEc2EcsComputeEnvironment

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

Inheritance
System.Object
Resource
ManagedEc2EcsComputeEnvironment
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ManagedEc2EcsComputeEnvironment : Resource, IManagedEc2EcsComputeEnvironment, IManagedComputeEnvironment, IComputeEnvironment, IResource, IConnectable, ITaggable
Syntax (vb)
Public Class ManagedEc2EcsComputeEnvironment
    Inherits Resource
    Implements IManagedEc2EcsComputeEnvironment, IManagedComputeEnvironment, IComputeEnvironment, IResource, IConnectable, ITaggable
Remarks

Resource: AWS::Batch::ComputeEnvironment

ExampleMetadata: infused

Examples
IManagedEc2EcsComputeEnvironment computeEnv;
var vpc = new Vpc(this, "VPC");
computeEnv.AddInstanceClass(InstanceClass.M5AD);
// Or, specify it on the constructor:
// Or, specify it on the constructor:
new ManagedEc2EcsComputeEnvironment(this, "myEc2ComputeEnv", new ManagedEc2EcsComputeEnvironmentProps {
    Vpc = vpc,
    InstanceClasses = new [] { InstanceClass.R4 }
});

Synopsis

Constructors

ManagedEc2EcsComputeEnvironment(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
ManagedEc2EcsComputeEnvironment(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
ManagedEc2EcsComputeEnvironment(Construct, String, IManagedEc2EcsComputeEnvironmentProps)

Properties

AllocationStrategy

The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.
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.
Images

Configure which AMIs this Compute Environment can launch.
InstanceClasses

The instance classes that this Compute Environment can launch.
InstanceRole

The execution Role that instances launched by this Compute Environment will use.
InstanceTypes

The instance types that this Compute Environment can launch.
LaunchTemplate

The Launch Template that this Compute Environment will use to provision EC2 Instances.
MaxvCpus

The maximum vCpus this ManagedComputeEnvironment can scale up to.
MinvCpus

The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.
PlacementGroup

The EC2 placement group to associate with your compute resources.
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.
SpotBidPercentage

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.
SpotFleetRole

The service-linked role that Spot Fleet needs to launch instances on your behalf.
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

AddInstanceClass(InstanceClass)

Add an instance class to this compute environment.
AddInstanceType(InstanceType)

Add an instance type to this compute environment.
FromManagedEc2EcsComputeEnvironmentArn(Construct, String, String)

refer to an existing ComputeEnvironment by its arn.

Constructors

ManagedEc2EcsComputeEnvironment(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected ManagedEc2EcsComputeEnvironment(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

ManagedEc2EcsComputeEnvironment(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected ManagedEc2EcsComputeEnvironment(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

ManagedEc2EcsComputeEnvironment(Construct, String, IManagedEc2EcsComputeEnvironmentProps)

public ManagedEc2EcsComputeEnvironment(Construct scope, string id, IManagedEc2EcsComputeEnvironmentProps props)
Parameters
scope Constructs.Construct
id System.String
props IManagedEc2EcsComputeEnvironmentProps

Properties

AllocationStrategy

The allocation strategy to use if not enough instances of the best fitting instance type can be allocated.

public virtual Nullable<AllocationStrategy> AllocationStrategy { get; }
Property Value

System.Nullable<AllocationStrategy>

ComputeEnvironmentArn

The ARN of this compute environment.

public virtual string ComputeEnvironmentArn { get; }
Property Value

System.String

ComputeEnvironmentName

The name of the ComputeEnvironment.

public virtual string ComputeEnvironmentName { get; }
Property Value

System.String

Connections

The network connections associated with this resource.

public virtual Connections_ Connections { get; }
Property Value

Connections_

Enabled

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

public virtual bool Enabled { get; }
Property Value

System.Boolean

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.

Images

Configure which AMIs this Compute Environment can launch.

public virtual IEcsMachineImage[] Images { get; }
Property Value

IEcsMachineImage[]

Remarks

Leave this undefined to allow Batch to choose the latest AMIs it supports for each instance that it launches.

InstanceClasses

The instance classes that this Compute Environment can launch.

public virtual InstanceClass[] InstanceClasses { get; }
Property Value

InstanceClass[]

Remarks

Which one is chosen depends on the AllocationStrategy used. Batch will automatically choose the size.

InstanceRole

The execution Role that instances launched by this Compute Environment will use.

public virtual IRole InstanceRole { get; }
Property Value

IRole

InstanceTypes

The instance types that this Compute Environment can launch.

public virtual InstanceType[] InstanceTypes { get; }
Property Value

InstanceType[]

Remarks

Which one is chosen depends on the AllocationStrategy used.

LaunchTemplate

The Launch Template that this Compute Environment will use to provision EC2 Instances.

public virtual ILaunchTemplate LaunchTemplate { get; }
Property Value

ILaunchTemplate

Remarks

Note: if securityGroups is specified on both your launch template and this Compute Environment, **the securityGroups on the Compute Environment override the ones on the launch template.

MaxvCpus

The maximum vCpus this ManagedComputeEnvironment can scale up to.

public virtual double MaxvCpus { get; }
Property Value

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

MinvCpus

The minimum vCPUs that an environment should maintain, even if the compute environment is DISABLED.

public virtual Nullable<double> MinvCpus { get; }
Property Value

System.Nullable<System.Double>

PlacementGroup

The EC2 placement group to associate with your compute resources.

public virtual IPlacementGroup PlacementGroup { get; }
Property Value

IPlacementGroup

Remarks

If you intend to submit multi-node parallel jobs to this Compute Environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential.

ReplaceComputeEnvironment

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

public virtual Nullable<bool> ReplaceComputeEnvironment { get; }
Property Value

System.Nullable<System.Boolean>

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[]

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

Spot

Whether or not to use spot instances.

public virtual Nullable<bool> Spot { get; }
Property Value

System.Nullable<System.Boolean>

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.

SpotBidPercentage

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.

public virtual Nullable<double> SpotBidPercentage { get; }
Property Value

System.Nullable<System.Double>

Remarks

For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Instance. You always pay the lowest market price and never more than your maximum percentage. For most use cases, Batch recommends leaving this field empty.

SpotFleetRole

The service-linked role that Spot Fleet needs to launch instances on your behalf.

public virtual IRole SpotFleetRole { get; }
Property Value

IRole

Tags

TagManager to set, remove and format tags.

public virtual TagManager Tags { get; }
Property Value

TagManager

TerminateOnUpdate

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

public virtual Nullable<bool> TerminateOnUpdate { get; }
Property Value

System.Nullable<System.Boolean>

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 Nullable<bool> UpdateToLatestImageVersion { get; }
Property Value

System.Nullable<System.Boolean>

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

AddInstanceClass(InstanceClass)

Add an instance class to this compute environment.

public virtual void AddInstanceClass(InstanceClass instanceClass)
Parameters
instanceClass InstanceClass

AddInstanceType(InstanceType)

Add an instance type to this compute environment.

public virtual void AddInstanceType(InstanceType instanceType)
Parameters
instanceType InstanceType

FromManagedEc2EcsComputeEnvironmentArn(Construct, String, String)

refer to an existing ComputeEnvironment by its arn.

public static IManagedEc2EcsComputeEnvironment FromManagedEc2EcsComputeEnvironmentArn(Construct scope, string id, string managedEc2EcsComputeEnvironmentArn)
Parameters
scope Constructs.Construct
id System.String
managedEc2EcsComputeEnvironmentArn System.String
Returns

IManagedEc2EcsComputeEnvironment

Implements

Constructs.IConstruct
Constructs.IDependable