aws_batch_compute_environment

account_id

Type: STRING

compute_environment_arn

Type: STRING
Provider name: computeEnvironmentArn
Description: The Amazon Resource Name (ARN) of the compute environment.

compute_environment_name

Type: STRING
Provider name: computeEnvironmentName
Description: 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

Type: STRUCT
Provider name: computeResources
Description: The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

• allocation_strategy
  Type: STRING
  Provider name: allocationStrategy
  Description: The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.

  BEST_FIT (default)

  Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren’t available, Batch waits for the additional instances to be available. If there aren’t enough instances available or the user is reaching Amazon EC2 service limits, additional jobs aren’t run until the currently running jobs are completed. This allocation strategy keeps costs lower but can limit scaling. If you’re using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don’t support infrastructure updates and can’t update some parameters. For more information, see Updating compute environments in the Batch User Guide.

  BEST_FIT_PROGRESSIVE

  Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren’t available, Batch selects new instance types.

  SPOT_CAPACITY_OPTIMIZED

  Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

  SPOT_PRICE_CAPACITY_OPTIMIZED

  The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.

  With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.
  
• bid_percentage
  Type: INT32
  Provider name: bidPercentage
  Description: The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. For most use cases, we recommend leaving this field empty. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.
  
• desiredv_cpus
  Type: INT32
  Provider name: desiredvCpus
  Description: The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.
  
• ec2_configuration
  Type: UNORDERED_LIST_STRUCT
  Provider name: ec2Configuration
  Description: Provides information that’s used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If Ec2Configuration isn’t specified, the default is ECS_AL2. One or two values can be provided. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.
  
  • image_id_override
    Type: STRING
    Provider name: imageIdOverride
    Description: The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource object. The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
    
  • image_kubernetes_version
    Type: STRING
    Provider name: imageKubernetesVersion
    Description: The Kubernetes version for the compute environment. If you don’t specify a value, the latest version that Batch supports is used.
    
  • image_type
    Type: STRING
    Provider name: imageType
    Description: The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS resources.

    ECS

    If the imageIdOverride parameter isn’t specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type that’s supported by Batch is used.

    ECS_AL2

    Amazon Linux 2: Default for all non-GPU instance families.

    ECS_AL2_NVIDIA

    Amazon Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

    ECS_AL2023

    Amazon Linux 2023: Batch supports Amazon Linux 2023. Amazon Linux 2023 does not support A1 instances.

    ECS_AL1

    Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.

    EKS

    If the imageIdOverride parameter isn’t specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

    EKS_AL2

    Amazon Linux 2: Default for all non-GPU instance families.

    EKS_AL2_NVIDIA

    Amazon Linux 2 (accelerated): Default for all GPU instance families (for example, P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

    
    
• ec2_key_pair
  Type: STRING
  Provider name: ec2KeyPair
  Description: The Amazon EC2 key pair that’s used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.
  
• image_id
  Type: STRING
  Provider name: imageId
  Description: The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it. The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.
  
• instance_role
  Type: STRING
  Provider name: instanceRole
  Description: The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This parameter is required for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS instance role in the Batch User Guide. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.
  
• instance_types
  Type: UNORDERED_LIST_STRING
  Provider name: instanceTypes
  Description: The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it. When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can’t mix x86 and ARM instances in the same compute environment. Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don’t have instance types from those instance families, instance types from the C5, M5, and R5 instance families are used.
  
• launch_template
  Type: STRUCT
  Provider name: launchTemplate
  Description: The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.
  
  • launch_template_id
    Type: STRING
    Provider name: launchTemplateId
    Description: The ID of the launch template.
    
  • launch_template_name
    Type: STRING
    Provider name: launchTemplateName
    Description: The name of the launch template.
    
  • overrides
    Type: UNORDERED_LIST_STRUCT
    Provider name: overrides
    Description: A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both. You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment. To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.
    
    • launch_template_id
      Type: STRING
      Provider name: launchTemplateId
      Description: The ID of the launch template. Note: If you specify the launchTemplateId you can’t specify the launchTemplateName as well.
      
    • launch_template_name
      Type: STRING
      Provider name: launchTemplateName
      Description: The name of the launch template. Note: If you specify the launchTemplateName you can’t specify the launchTemplateId as well.
      
    • target_instance_types
      Type: UNORDERED_LIST_STRING
      Provider name: targetInstanceTypes
      Description: The instance type or family that this override launch template should be applied to. This parameter is required when defining a launch template override. Information included in this parameter must meet the following requirements:
      • Must be a valid Amazon EC2 instance type or family.
      • optimal isn’t allowed.
      • targetInstanceTypes can target only instance types and families that are included within the ComputeResource.instanceTypes set. targetInstanceTypes doesn’t need to include all of the instances from the instanceType set, but at least a subset. For example, if ComputeResource.instanceTypes includes [m5, g5], targetInstanceTypes can include [m5.2xlarge] and [m5.large] but not [c5.large].
      • targetInstanceTypes included within the same launch template override or across launch template overrides can’t overlap for the same compute environment. For example, you can’t define one launch template override to target an instance family and another define an instance type within this same family.
    • version
      Type: STRING
      Provider name: version
      Description: The version number of the launch template, $Default, or $Latest. If the value is $Default, the default version of the launch template is used. If the value is $Latest, the latest version of the launch template is used. If the AMI ID that’s used in a compute environment is from the launch template, the AMI isn’t changed when the compute environment is updated. It’s only changed if the updateToLatestImageVersion parameter for the compute environment is set to true. During an infrastructure update, if either $Default or $Latest is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn’t specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
      Default: $Default

      Latest: $Latest

  • version
    Type: STRING
    Provider name: version
    Description: The version number of the launch template, $Default, or $Latest. If the value is $Default, the default version of the launch template is used. If the value is $Latest, the latest version of the launch template is used. If the AMI ID that’s used in a compute environment is from the launch template, the AMI isn’t changed when the compute environment is updated. It’s only changed if the updateToLatestImageVersion parameter for the compute environment is set to true. During an infrastructure update, if either $Default or $Latest is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn’t specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.
    Default: $Default

    Latest: $Latest

• maxv_cpus
  Type: INT32
  Provider name: maxvCpus
  Description: The maximum number of vCPUs that a compute environment can support. With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.
  
• minv_cpus
  Type: INT32
  Provider name: minvCpus
  Description: The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is DISABLED). This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.
  
• placement_group
  Type: STRING
  Provider name: placementGroup
  Description: The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it.
  
• security_group_ids
  Type: UNORDERED_LIST_STRING
  Provider name: securityGroupIds
  Description: The Amazon EC2 security groups that are associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs that are running on Fargate resources and must contain at least one security group. Fargate doesn’t support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds are used.
  
• spot_iam_fleet_role
  Type: STRING
  Provider name: spotIamFleetRole
  Description: The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn’t specified. For more information, see Amazon EC2 spot fleet role in the Batch User Guide. This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t specify it. To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn’t have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.
  
• subnets
  Type: UNORDERED_LIST_STRING
  Provider name: subnets
  Description: The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User Guide. Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide. Batch on Fargate doesn’t currently support Local Zones.
  
• type
  Type: STRING
  Provider name: type
  Description: The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute environments in the Batch User Guide. If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.
  

container_orchestration_type

Type: STRING
Provider name: containerOrchestrationType
Description: The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

context

Type: STRING
Provider name: context
Description: Reserved.

ecs_cluster_arn

Type: STRING
Provider name: ecsClusterArn
Description: The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.

eks_configuration

Type: STRUCT
Provider name: eksConfiguration
Description: The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

• eks_cluster_arn
  Type: STRING
  Provider name: eksClusterArn
  Description: The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch .
  
• kubernetes_namespace
  Type: STRING
  Provider name: kubernetesNamespace
  Description: The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can’t left empty or null. It must be fewer than 64 characters long, can’t be set to default, can’t start with “kube-,” and must match this regular expression: ^a-z0-9?$. For more information, see Namespaces in the Kubernetes documentation.
  

service_role

Type: STRING
Provider name: serviceRole
Description: 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

Type: STRING
Provider name: state
Description: 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.

status

Type: STRING
Provider name: status
Description: The current status of the compute environment (for example, CREATING or VALID).

status_reason

Type: STRING
Provider name: statusReason
Description: A short, human-readable string to provide additional details for the current status of the compute environment.

tags

Type: UNORDERED_LIST_STRING

type

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

unmanagedv_cpus

Type: INT32
Provider name: unmanagedvCpus
Description: The maximum number of VCPUs expected to be used for an unmanaged compute environment.

update_policy

Type: STRUCT
Provider name: updatePolicy
Description: Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

• job_execution_timeout_minutes
  Type: INT64
  Provider name: jobExecutionTimeoutMinutes
  Description: Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30.
  
• terminate_jobs_on_update
  Type: BOOLEAN
  Provider name: terminateJobsOnUpdate
  Description: Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The default value is false.
  

uuid

Type: STRING
Provider name: uuid
Description: Unique identifier for the compute environment.