Package software.amazon.awscdk.services.batch

Class CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder

java.lang.Object

software.amazon.awscdk.services.batch.CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnComputeEnvironment.Ec2ConfigurationObjectProperty

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

A builder for CfnComputeEnvironment.Ec2ConfigurationObjectProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnComputeEnvironment.Ec2ConfigurationObjectProperty	build()	Builds the configured instance.
CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder	imageIdOverride(String imageIdOverride)	Sets the value of CfnComputeEnvironment.Ec2ConfigurationObjectProperty.getImageIdOverride()
CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder	imageKubernetesVersion(String imageKubernetesVersion)	Sets the value of CfnComputeEnvironment.Ec2ConfigurationObjectProperty.getImageKubernetesVersion()
CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder	imageType(String imageType)	Sets the value of CfnComputeEnvironment.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

imageType

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

Sets the value of CfnComputeEnvironment.Ec2ConfigurationObjectProperty.getImageType()

Parameters:

imageType - The image type to match with the instance type to select an AMI. This parameter is required. 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.
• 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_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 AWS 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 AWS Graviton-based instance types.

Returns:

this

imageIdOverride

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

Sets the value of CfnComputeEnvironment.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 CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder imageKubernetesVersion(String imageKubernetesVersion)

Sets the value of CfnComputeEnvironment.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

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnComputeEnvironment.Ec2ConfigurationObjectProperty

Throws:

NullPointerException - if any required attribute was not provided