Batch Compute Engine Environment

This table represents the Batch Compute Engine Environment resource from Amazon Web Services.

aws.batch_compute_environment

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
compute_environment_arncorestringThe Amazon Resource Name (ARN) of the compute environment.
compute_environment_namecorestringThe name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
compute_resourcescorejsonThe compute resources defined for the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the <i>Batch User Guide</i>.
container_orchestration_typecorestringThe orchestration type of the compute environment. The valid values are <code>ECS</code> (default) or <code>EKS</code>.
contextcorestringReserved.
ecs_cluster_arncorestringThe Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
eks_configurationcorejsonThe configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the <code>containerOrchestrationType</code> is <code>EKS</code>.
service_rolecorestringThe 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 <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM role</a> in the <i>Batch User Guide</i>.
statecorestringThe state of the compute environment. The valid values are <code>ENABLED</code> or <code>DISABLED</code>. If the state is <code>ENABLED</code>, 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 <code>DISABLED</code>, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a <code>STARTING</code> or <code>RUNNING</code> state continue to progress normally. Managed compute environments in the <code>DISABLED</code> state don't scale out. <note> Compute environments in a <code>DISABLED</code> state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state">State</a> in the <i>Batch User Guide</i>. </note> When an instance is idle, the instance scales down to the <code>minvCpus</code> value. However, the instance size doesn't change. For example, consider a <code>c5.8xlarge</code> instance with a <code>minvCpus</code> value of <code>4</code> and a <code>desiredvCpus</code> value of <code>36</code>. This instance doesn't scale down to a <code>c5.large</code> instance.
statuscorestringThe current status of the compute environment (for example, <code>CREATING</code> or <code>VALID</code>).
status_reasoncorestringA short, human-readable string to provide additional details for the current status of the compute environment.
tagscorehstore
typecorestringThe type of the compute environment: <code>MANAGED</code> or <code>UNMANAGED</code>. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in the <i>Batch User Guide</i>.
unmanagedv_cpuscoreint64The maximum number of VCPUs expected to be used for an unmanaged compute environment.
update_policycorejsonSpecifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the <i>Batch User Guide</i>.
uuidcorestringUnique identifier for the compute environment.