Class ComputeEnvironmentProps

Props common to all ComputeEnvironments.

Inheritance

object

ComputeEnvironmentProps

Implements

IComputeEnvironmentProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ComputeEnvironmentProps : IComputeEnvironmentProps

Syntax (vb)

Public Class ComputeEnvironmentProps Implements IComputeEnvironmentProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Batch;
            using Amazon.CDK.AWS.IAM;

            Role role;

            var computeEnvironmentProps = new ComputeEnvironmentProps {
                ComputeEnvironmentName = "computeEnvironmentName",
                Enabled = false,
                ServiceRole = role
            };

Synopsis

Constructors

ComputeEnvironmentProps()

Props common to all ComputeEnvironments.

Properties

ComputeEnvironmentName	The name of the ComputeEnvironment.
Enabled	Whether or not this ComputeEnvironment can accept jobs from a Queue.
ServiceRole	The role Batch uses to perform actions on your behalf in your account, such as provision instances to run your jobs.

Constructors

ComputeEnvironmentProps()

Props common to all ComputeEnvironments.

public ComputeEnvironmentProps()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Batch;
            using Amazon.CDK.AWS.IAM;

            Role role;

            var computeEnvironmentProps = new ComputeEnvironmentProps {
                ComputeEnvironmentName = "computeEnvironmentName",
                Enabled = false,
                ServiceRole = role
            };

Properties

ComputeEnvironmentName

The name of the ComputeEnvironment.

public string? ComputeEnvironmentName { get; set; }

Property Value

string

Remarks

Default: - generated by CloudFormation

Enabled

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

public bool? Enabled { get; set; }

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.

Default: true

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

IRole

Remarks

Default: - a serviceRole will be created for managed CEs, none for unmanaged CEs

Implements

IComputeEnvironmentProps