Class: Aws::Batch::Types::Ec2Configuration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 (Amazon ECS-optimized Amazon Linux 2) for EC2 (ECS) compute environments and EKS_AL2023 (Amazon EKS-optimized Amazon Linux 2023 AMI) for EKS compute environments.

This object isn't applicable to jobs that are running on Fargate resources.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_image_status ⇒ String

The status of the Batch-provided default AMIs associated with the imageType.

The field only appears after the compute environment has begun scaling instances using the imageType. The field is not present when an image is specified in ComputeResources.imageId (deprecated), the default launch template, or Ec2Configuration.imageIdOverride. The field is also not present when the compute environment has a launch template override. For more information on image selection, see AMI selection order.

This field is read-only and only appears in the DescribeComputeEnvironments response.

  • LATEST − Using the most recent AMI supported

  • UPDATE_AVAILABLE − An updated AMI is available

    • If a compute environment has multiple AMIs for the imageType and any one AMI has UPDATE_AVAILABLE, the status shows UPDATE_AVAILABLE.

    • For compute environments that use BEST_FIT as their allocation strategy, you can perform a blue/green update to update the AMI.

    • For all other compute environments, you can perform an AMI version update to update the AMI to the latest version.

Returns:

  • (String) 


4019
4020
4021
4022
4023
4024
4025
4026
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4019

class Ec2Configuration < Struct.new(
  :image_type,
  :image_id_override,
  :batch_image_status,
  :image_kubernetes_version)
  SENSITIVE = []
  include Aws::Structure
end

#image_id_override ⇒ String

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.

Returns:

  • (String) 


4019
4020
4021
4022
4023
4024
4025
4026
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4019

class Ec2Configuration < Struct.new(
  :image_type,
  :image_id_override,
  :batch_image_status,
  :image_kubernetes_version)
  SENSITIVE = []
  include Aws::Structure
end

#image_kubernetes_version ⇒ String

The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch supports is used.

Returns:

  • (String) 


4019
4020
4021
4022
4023
4024
4025
4026
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4019

class Ec2Configuration < Struct.new(
  :image_type,
  :image_id_override,
  :batch_image_status,
  :image_kubernetes_version)
  SENSITIVE = []
  include Aws::Structure
end

#image_type ⇒ String

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.

Amazon Web Services will end support for Amazon ECS optimized AL2-optimized and AL2-accelerated AMIs. Starting in January 2026, Batch will change the default AMI for new Amazon ECS compute environments from Amazon Linux 2 to Amazon Linux 2023. We recommend migrating Batch Amazon ECS compute environments to Amazon Linux 2023 to maintain optimal performance and security. For more information on upgrading from AL2 to AL2023, see How to migrate from ECS AL2 to ECS AL2023 in the Batch User Guide.

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_AL2023_NVIDIA

Amazon Linux 2023 (GPU): For all GPU instance families and can be used for all non Amazon Web Services Graviton-based instance types.

ECS_AL2023_NVIDIA doesn't support p3 and g3 instance types.

EKS

If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux 2023 AMI (EKS_AL2023) 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.

Amazon Linux 2023 AMIs are the default on Batch for Amazon EKS.

Amazon Web Services will end support for Amazon EKS AL2-optimized and AL2-accelerated AMIs, starting 11/26/25. You can continue using Batch-provided Amazon EKS optimized Amazon Linux 2 AMIs on your Amazon EKS compute environments beyond the 11/26/25 end-of-support date, these compute environments will no longer receive any new software updates, security patches, or bug fixes from Amazon Web Services. For more information on upgrading from AL2 to AL2023, see How to upgrade from EKS AL2 to EKS AL2023 in the Batch User Guide.

EKS_AL2

Amazon Linux 2: Used for non-GPU instance families.

EKS_AL2_NVIDIA

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

EKS_AL2023

Amazon Linux 2023: Default for non-GPU instance families.

Amazon Linux 2023 does not support A1 instances.

EKS_AL2023_NVIDIA

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

Returns:

  • (String) 


4019
4020
4021
4022
4023
4024
4025
4026
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 4019

class Ec2Configuration < Struct.new(
  :image_type,
  :image_id_override,
  :batch_image_status,
  :image_kubernetes_version)
  SENSITIVE = []
  include Aws::Structure
end