Class FargateComputeEnvironmentProps
Props for a FargateComputeEnvironment.
Inheritance
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class FargateComputeEnvironmentProps : Object, IFargateComputeEnvironmentProps, IManagedComputeEnvironmentProps, IComputeEnvironmentProps
Syntax (vb)
Public Class FargateComputeEnvironmentProps
Inherits Object
Implements IFargateComputeEnvironmentProps, IManagedComputeEnvironmentProps, IComputeEnvironmentProps
Remarks
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
FargateComputeEnvironmentProps() |
Properties
ComputeEnvironmentName | The name of the ComputeEnvironment. |
Enabled | Whether or not this ComputeEnvironment can accept jobs from a Queue. |
MaxvCpus | The maximum vCpus this |
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. |
TerminateOnUpdate | Whether or not any running jobs will be immediately terminated when an infrastructure update occurs. |
UpdateTimeout | Only meaningful if |
UpdateToLatestImageVersion | Whether or not the AMI is updated to the latest one supported by Batch when an infrastructure update occurs. |
Vpc | VPC in which this Compute Environment will launch Instances. |
VpcSubnets | The VPC Subnets this Compute Environment will launch instances in. |
Constructors
FargateComputeEnvironmentProps()
public FargateComputeEnvironmentProps()
Properties
ComputeEnvironmentName
The name of the ComputeEnvironment.
public string ComputeEnvironmentName { get; set; }
Property Value
System.String
Remarks
Default: - generated by CloudFormation
Enabled
Whether or not this ComputeEnvironment can accept jobs from a Queue.
public Nullable<bool> Enabled { get; set; }
Property Value
System.Nullable<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
.
Default: true
MaxvCpus
The maximum vCpus this ManagedComputeEnvironment
can scale up to. Each vCPU is equivalent to 1024 CPU shares.
public Nullable<double> MaxvCpus { get; set; }
Property Value
System.Nullable<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
.
Default: 256
ReplaceComputeEnvironment
Specifies whether this Compute Environment is replaced if an update is made that requires replacing its instances.
public Nullable<bool> ReplaceComputeEnvironment { get; set; }
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:
Default: false
SecurityGroups
The security groups this Compute Environment will launch instances in.
public ISecurityGroup[] SecurityGroups { get; set; }
Property Value
Remarks
Default: new security groups will be created
ServiceRole
The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.
public IRole ServiceRole { get; set; }
Property Value
Remarks
Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs
Spot
Whether or not to use spot instances.
public Nullable<bool> Spot { get; set; }
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.
Default: false
TerminateOnUpdate
Whether or not any running jobs will be immediately terminated when an infrastructure update occurs.
public Nullable<bool> TerminateOnUpdate { get; set; }
Property Value
System.Nullable<System.Boolean>
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
.
public Duration UpdateTimeout { get; set; }
Property Value
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.
public Nullable<bool> UpdateToLatestImageVersion { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If you specify a specific AMI, this property will be ignored.
Default: true
Vpc
VPC in which this Compute Environment will launch Instances.
public IVpc Vpc { get; set; }
Property Value
VpcSubnets
The VPC Subnets this Compute Environment will launch instances in.
public ISubnetSelection VpcSubnets { get; set; }
Property Value
Remarks
Default: new subnets will be created