ComputeEnvironmentDetail
¶
Source code in docs_src/capo_batch/types/compute_environment_detail.py
compute_environment_arn
instance-attribute
¶
compute_environment_arn: NotRequired[String]
The Amazon Resource Name (ARN) of the compute environment.
compute_environment_name
instance-attribute
¶
compute_environment_name: NotRequired[String]
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 (_).
compute_resources
instance-attribute
¶
compute_resources: NotRequired[ComputeResource]
The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.
container_orchestration_type
instance-attribute
¶
container_orchestration_type: NotRequired[OrchestrationType]
The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
ecs_cluster_arn
instance-attribute
¶
ecs_cluster_arn: NotRequired[String]
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
ecs_settings
instance-attribute
¶
ecs_settings: NotRequired[EcsSettings]
The Amazon ECS settings for the compute environment. These settings control CloudWatch Container Insights collection.
eks_configuration
instance-attribute
¶
eks_configuration: NotRequired[EksConfiguration]
The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.
service_role
instance-attribute
¶
service_role: NotRequired[String]
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.
state
instance-attribute
¶
state: NotRequired[CEState]
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, for example, if they have running instances due to jobs that are still executing or a non-zero minvCpus setting. To prevent additional charges, disable and delete the compute environment.
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.
status
instance-attribute
¶
status: NotRequired[CEStatus]
The current status of the compute environment (for example, CREATING or VALID).
status_reason
instance-attribute
¶
status_reason: NotRequired[String]
A short, human-readable string to provide additional details for the current status of the compute environment.
tags
instance-attribute
¶
tags: NotRequired[TagrisTagsMap]
The tags applied to the compute environment.
type
instance-attribute
¶
type: NotRequired[CEType]
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the Batch User Guide.
unmanagedv_cpus
instance-attribute
¶
unmanagedv_cpus: NotRequired[Integer]
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
update_policy
instance-attribute
¶
update_policy: NotRequired[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.