Package software.amazon.awscdk.services.batch

Interface CfnComputeEnvironment.Ec2ConfigurationObjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Jsii$Proxy

Enclosing class:

CfnComputeEnvironment

@Stability(Stable)
public static interface CfnComputeEnvironment.Ec2ConfigurationObjectProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 Ec2ConfigurationObjectProperty ec2ConfigurationObjectProperty = Ec2ConfigurationObjectProperty.builder()
         .imageType("imageType")
         // the properties below are optional
         .imageIdOverride("imageIdOverride")
         .imageKubernetesVersion("imageKubernetesVersion")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder	A builder for CfnComputeEnvironment.Ec2ConfigurationObjectProperty
static final class	CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Jsii$Proxy	An implementation for CfnComputeEnvironment.Ec2ConfigurationObjectProperty

Method Summary

Modifier and Type	Method	Description
static CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder	builder()
default String	getImageIdOverride()	The AMI ID used for instances launched in the compute environment that match the image type.
default String	getImageKubernetesVersion()	The Kubernetes version for the compute environment.
String	getImageType()	The image type to match with the instance type to select an AMI.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImageType

@Stability(Stable)
@NotNull
String getImageType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imagetype

getImageIdOverride

@Stability(Stable)
@Nullable
default String getImageIdOverride()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imageidoverride

getImageKubernetesVersion

@Stability(Stable)
@Nullable
default String getImageKubernetesVersion()

The Kubernetes version for the compute environment.

If you don't specify a value, the latest version that AWS Batch supports is used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html#cfn-batch-computeenvironment-ec2configurationobject-imagekubernetesversion

builder

@Stability(Stable)
static CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder builder()

Returns:

a CfnComputeEnvironment.Ec2ConfigurationObjectProperty.Builder of CfnComputeEnvironment.Ec2ConfigurationObjectProperty