/AWS1/CL_BTCEC2CONFIGURATION¶
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).
This object isn't applicable to jobs that are running on Fargate resources.
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
iv_imagetype
TYPE /AWS1/BTCIMAGETYPE
/AWS1/BTCIMAGETYPE
¶
The image type to match with the instance type to select an AMI. The supported values are different for
ECS
andEKS
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 animageId
nor aimageIdOverride
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
andG4
) 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
andg3
instance types.- 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 animageId
nor aimageIdOverride
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: Default for all non-GPU instance families.
- EKS_AL2_NVIDIA
Amazon Linux 2 (accelerated): Default for all GPU instance families (for example,
P4
andG4
) and can be used for all non Amazon Web Services Graviton-based instance types.- EKS_AL2023
Amazon Linux 2023: Batch supports Amazon Linux 2023.
Amazon Linux 2023 does not support
A1
instances.- EKS_AL2023_NVIDIA
Amazon Linux 2023 (accelerated): GPU instance families and can be used for all non Amazon Web Services Graviton-based instance types.
Optional arguments:¶
iv_imageidoverride
TYPE /AWS1/BTCIMAGEIDOVERRIDE
/AWS1/BTCIMAGEIDOVERRIDE
¶
The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the
imageId
set in thecomputeResource
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.
iv_imagekubernetesversion
TYPE /AWS1/BTCKUBERNETESVERSION
/AWS1/BTCKUBERNETESVERSION
¶
The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch supports is used.
Queryable Attributes¶
imageType¶
The image type to match with the instance type to select an AMI. The supported values are different for
ECS
andEKS
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 animageId
nor aimageIdOverride
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
andG4
) 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
andg3
instance types.- 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 animageId
nor aimageIdOverride
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: Default for all non-GPU instance families.
- EKS_AL2_NVIDIA
Amazon Linux 2 (accelerated): Default for all GPU instance families (for example,
P4
andG4
) and can be used for all non Amazon Web Services Graviton-based instance types.- EKS_AL2023
Amazon Linux 2023: Batch supports Amazon Linux 2023.
Amazon Linux 2023 does not support
A1
instances.- EKS_AL2023_NVIDIA
Amazon Linux 2023 (accelerated): GPU instance families and can be used for all non Amazon Web Services Graviton-based instance types.
Accessible with the following methods¶
Method | Description |
---|---|
GET_IMAGETYPE() |
Getter for IMAGETYPE, with configurable default |
ASK_IMAGETYPE() |
Getter for IMAGETYPE w/ exceptions if field has no value |
HAS_IMAGETYPE() |
Determine if IMAGETYPE has a value |
imageIdOverride¶
The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the
imageId
set in thecomputeResource
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_IMAGEIDOVERRIDE() |
Getter for IMAGEIDOVERRIDE, with configurable default |
ASK_IMAGEIDOVERRIDE() |
Getter for IMAGEIDOVERRIDE w/ exceptions if field has no val |
HAS_IMAGEIDOVERRIDE() |
Determine if IMAGEIDOVERRIDE has a value |
imageKubernetesVersion¶
The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch supports is used.
Accessible with the following methods¶
Method | Description |
---|---|
GET_IMAGEKUBERNETESVERSION() |
Getter for IMAGEKUBERNETESVERSION, with configurable default |
ASK_IMAGEKUBERNETESVERSION() |
Getter for IMAGEKUBERNETESVERSION w/ exceptions if field has |
HAS_IMAGEKUBERNETESVERSION() |
Determine if IMAGEKUBERNETESVERSION has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_EC2CONFIGURATIONLIST
¶
TYPES TT_EC2CONFIGURATIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_BTCEC2CONFIGURATION WITH DEFAULT KEY
.