Package software.amazon.awscdk.cfnpropertymixins.services.batch

Class CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.batch.CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty>

Enclosing interface:

CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty

@Stability(Stable)
public static final class CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty>

A builder for CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty	build()	Builds the configured instance.
CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.Builder	imageIdOverride(String imageIdOverride)	Sets the value of CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.getImageIdOverride()
CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.Builder	imageKubernetesVersion(String imageKubernetesVersion)	Sets the value of CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.getImageKubernetesVersion()
CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.Builder	imageType(String imageType)	Sets the value of CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.getImageType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

imageIdOverride

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.Builder imageIdOverride(String imageIdOverride)

Sets the value of CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.getImageIdOverride()

Parameters:

imageIdOverride - 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:

this

imageKubernetesVersion

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.Builder imageKubernetesVersion(String imageKubernetesVersion)

Sets the value of CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.getImageKubernetesVersion()

Parameters:

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

Returns:

this

imageType

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.Builder imageType(String imageType)

Sets the value of CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty.getImageType()

Parameters:

imageType - 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 AWS Batch is used.

AWS will end support for Amazon ECS optimized AL2-optimized and AL2-accelerated AMIs. Starting in January 2026, AWS Batch will change the default AMI for new Amazon ECS compute environments from Amazon Linux 2 to Amazon Linux 2023. We recommend migrating AWS 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 AWS 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 AWS Graviton-based instance types.
• ECS_AL2023 - Amazon Linux 2023 : AWS 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 AWS 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 AWS Batch supports is used.

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

AWS will end support for Amazon EKS AL2-optimized and AL2-accelerated AMIs, starting 11/26/25. You can continue using AWS 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 AWS . For more information on upgrading from AL2 to AL2023, see How to upgrade from EKS AL2 to EKS AL2023 in the AWS 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 AWS 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 AWS Graviton-based instance types.

Returns:

this

build

@Stability(Stable)
public CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty>

Returns:

a new instance of CfnComputeEnvironmentPropsMixin.Ec2ConfigurationObjectProperty

Throws:

NullPointerException - if any required attribute was not provided