Documentation

An object that represents an Batch compute environment.

See: newComputeEnvironmentDetail smart constructor.

Create a value of ComputeEnvironmentDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:computeResources:ComputeEnvironmentDetail', computeEnvironmentDetail_computeResources - The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

$sel:containerOrchestrationType:ComputeEnvironmentDetail', computeEnvironmentDetail_containerOrchestrationType - The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

$sel:ecsClusterArn:ComputeEnvironmentDetail', computeEnvironmentDetail_ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.

$sel:eksConfiguration:ComputeEnvironmentDetail', computeEnvironmentDetail_eksConfiguration - The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

$sel:serviceRole:ComputeEnvironmentDetail', computeEnvironmentDetail_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.

$sel:state:ComputeEnvironmentDetail', computeEnvironmentDetail_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. However, they scale in to minvCpus value after instances become idle.

$sel:status:ComputeEnvironmentDetail', computeEnvironmentDetail_status - The current status of the compute environment (for example, CREATING or VALID).

$sel:statusReason:ComputeEnvironmentDetail', computeEnvironmentDetail_statusReason - A short, human-readable string to provide additional details for the current status of the compute environment.

ComputeEnvironmentDetail, computeEnvironmentDetail_tags - The tags applied to the compute environment.

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

$sel:unmanagedvCpus:ComputeEnvironmentDetail', computeEnvironmentDetail_unmanagedvCpus - The maximum number of VCPUs expected to be used for an unmanaged compute environment.

$sel:updatePolicy:ComputeEnvironmentDetail', computeEnvironmentDetail_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.

$sel:uuid:ComputeEnvironmentDetail', computeEnvironmentDetail_uuid - Unique identifier for the compute environment.

$sel:computeEnvironmentName:ComputeEnvironmentDetail', computeEnvironmentDetail_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 (_).

$sel:computeEnvironmentArn:ComputeEnvironmentDetail', computeEnvironmentDetail_computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.

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

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

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

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

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.

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. However, they scale in to minvCpus value after instances become idle.

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

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

The tags applied to the compute environment.

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

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

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

Unique identifier for the compute environment.

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

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