Class UnmanagedComputeEnvironmentProps

Represents an UnmanagedComputeEnvironment.

Inheritance
object
UnmanagedComputeEnvironmentProps
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UnmanagedComputeEnvironmentProps : IUnmanagedComputeEnvironmentProps, IComputeEnvironmentProps
Syntax (vb)
Public Class UnmanagedComputeEnvironmentProps Implements IUnmanagedComputeEnvironmentProps, IComputeEnvironmentProps
Remarks

Batch will not provision instances on your behalf in this ComputeEvironment.

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 unmanagedComputeEnvironmentProps = new UnmanagedComputeEnvironmentProps {
                 ComputeEnvironmentName = "computeEnvironmentName",
                 Enabled = false,
                 ServiceRole = role,
                 UnmanagedvCpus = 123
             };

Synopsis

Constructors

UnmanagedComputeEnvironmentProps()

Represents an UnmanagedComputeEnvironment.

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

The vCPUs this Compute Environment provides. Used only by the scheduler to schedule jobs in Queues that use FairshareSchedulingPolicys.

Constructors

UnmanagedComputeEnvironmentProps()

Represents an UnmanagedComputeEnvironment.

public UnmanagedComputeEnvironmentProps()
Remarks

Batch will not provision instances on your behalf in this ComputeEvironment.

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 unmanagedComputeEnvironmentProps = new UnmanagedComputeEnvironmentProps {
                 ComputeEnvironmentName = "computeEnvironmentName",
                 Enabled = false,
                 ServiceRole = role,
                 UnmanagedvCpus = 123
             };

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

UnmanagedvCpus

The vCPUs this Compute Environment provides. Used only by the scheduler to schedule jobs in Queues that use FairshareSchedulingPolicys.

public double? UnmanagedvCpus { get; set; }
Property Value

double?

Remarks

If this parameter is not provided on a fairshare queue, no capacity is reserved; that is, the FairshareSchedulingPolicy is ignored.

Default: 0

Implements