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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 Linux 2]).

<note markdown=“1”> This object isn’t applicable to jobs that are running on Fargate resources.

</note>

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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.

<note markdown=“1”> 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*.

</note>

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html

Returns:

  • (String) 


3687
3688
3689
3690
3691
3692
3693
 
# File 'lib/aws-sdk-batch/types.rb', line 3687

class Ec2Configuration < Struct.new(
  :image_type,
  :image_id_override,
  :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) 


3687
3688
3689
3690
3691
3692
3693
 
# File 'lib/aws-sdk-batch/types.rb', line 3687

class Ec2Configuration < Struct.new(
  :image_type,
  :image_id_override,
  :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][1] (`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][1]: Default for all non-GPU instance families.

ECS\_AL2\_NVIDIA

: [Amazon Linux 2 (GPU)][2]: 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][3]: Batch supports Amazon Linux 2023.

  <note markdown="1"> Amazon Linux 2023 does not support `A1` instances.

   </note>

ECS\_AL2023\_NVIDIA

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

  <note markdown="1"> ECS\_AL2023\_NVIDIA doesn't support `p3` and `g3` instance
  types.

   </note>

ECS\_AL1

: [Amazon Linux][4]. Amazon Linux has reached the end-of-life of
  standard support. For more information, see [Amazon Linux
  AMI][5].

EKS

: If the ‘imageIdOverride` parameter isn’t specified, then a recent

[Amazon EKS-optimized Amazon Linux AMI][6] (`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.

Starting end of October 2025 Amazon EKS optimized Amazon Linux
2023 AMIs will be the default on Batch for EKS versions prior to
1.33. Starting from Kubernetes version 1.33, EKS optimized Amazon
Linux 2023 AMIs will be the default when it becomes supported on
Batch.

 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][6]: Default for all non-GPU instance families.

EKS\_AL2\_NVIDIA

: [Amazon Linux 2 (accelerated)][6]: 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.

EKS\_AL2023

: [Amazon Linux 2023][6]: Batch supports Amazon Linux 2023.

  <note markdown="1"> Amazon Linux 2023 does not support `A1` instances.

   </note>

EKS\_AL2023\_NVIDIA

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

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami [3]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html [4]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami [5]: aws.amazon.com/amazon-linux-ami/ [6]: docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html

Returns:

  • (String) 


3687
3688
3689
3690
3691
3692
3693
 
# File 'lib/aws-sdk-batch/types.rb', line 3687

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