ComputeEnvironmentDetail

An object that represents an AWS Batch compute environment.

computeEnvironmentArn

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

Type: String

Required: Yes

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 (_).

Type: String

Required: Yes

computeResources

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

Type: ComputeResource object

Required: No

containerOrchestrationType

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

Type: String

Valid Values: ECS | EKS

Required: No

context

Reserved.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

ecsClusterArn

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

Type: String

Required: No

eksConfiguration

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

Type: EksConfiguration object

Required: No

serviceRole

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

Type: String

Required: No

state

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

If the state is ENABLED, then the AWS 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 AWS 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.

Note

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

Type: String

Valid Values: ENABLED | DISABLED

Required: No

status

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

Type: String

Required: No

statusReason

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

Type: String

Required: No

tags

The tags applied to the compute environment.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

type

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

Type: String

Valid Values: MANAGED | UNMANAGED

Required: No

unmanagedvCpus

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

Type: Integer

Required: No

updatePolicy

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

Type: UpdatePolicy object

Required: No

uuid

Unique identifier for the compute environment.

Type: String

Required: No

ComputeEnvironmentDetail

Contents

Note

See Also