AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

An object that represents an Batch compute environment.

Inheritance Hierarchy

System.Object
  Amazon.Batch.Model.ComputeEnvironmentDetail

Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

C#
public class ComputeEnvironmentDetail

The ComputeEnvironmentDetail type exposes the following members

Constructors

NameDescription
Public Method ComputeEnvironmentDetail()

Properties

NameTypeDescription
Public Property ComputeEnvironmentArn System.String

Gets and sets the property ComputeEnvironmentArn.

The Amazon Resource Name (ARN) of the compute environment.

Public Property ComputeEnvironmentName System.String

Gets and sets the property ComputeEnvironmentName.

The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Public Property ComputeResources Amazon.Batch.Model.ComputeResource

Gets and sets the property ComputeResources.

The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

Public Property ContainerOrchestrationType Amazon.Batch.OrchestrationType

Gets and sets the property ContainerOrchestrationType.

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

Public Property Context System.String

Gets and sets the property Context.

Reserved.

Public Property EcsClusterArn System.String

Gets and sets the property EcsClusterArn.

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.

Public Property EksConfiguration Amazon.Batch.Model.EksConfiguration

Gets and sets the property EksConfiguration.

The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

Public Property ServiceRole System.String

Gets and sets the property ServiceRole.

The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

Public Property State Amazon.Batch.CEState

Gets and sets the property State.

The state of the compute environment. The valid values are ENABLED or DISABLED.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out.

Compute environments in a DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.

When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large instance.

Public Property Status Amazon.Batch.CEStatus

Gets and sets the property Status.

The current status of the compute environment (for example, CREATING or VALID).

Public Property StatusReason System.String

Gets and sets the property StatusReason.

A short, human-readable string to provide additional details for the current status of the compute environment.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

The tags applied to the compute environment.

Public Property Type Amazon.Batch.CEType

Gets and sets the property Type.

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the Batch User Guide.

Public Property UnmanagedvCpus System.Int32

Gets and sets the property UnmanagedvCpus.

The maximum number of VCPUs expected to be used for an unmanaged compute environment.

Public Property UpdatePolicy Amazon.Batch.Model.UpdatePolicy

Gets and sets the property UpdatePolicy.

Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

Public Property Uuid System.String

Gets and sets the property Uuid.

Unique identifier for the compute environment.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5