Ec2Configuration Class | AWS SDK for .NET V3

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.

Inheritance Hierarchy

System.Object
Amazon.Batch.Model.Ec2Configuration

Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

public class Ec2Configuration

The Ec2Configuration type exposes the following members

Constructors

	Name	Description
	Ec2Configuration()

Properties

Name Type Description

Name	Type	Description
ImageIdOverride	System.String	Gets and sets the property 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.
ImageKubernetesVersion	System.String	Gets and sets the property ImageKubernetesVersion. The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch supports is used.
ImageType	System.String	Gets and sets the property 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 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 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_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 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 Amazon Web Services Graviton-based instance types.

ImageIdOverride

System.String

Gets and sets the property 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.

ImageKubernetesVersion

System.String

Gets and sets the property ImageKubernetesVersion.

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

ImageType

System.String

Gets and sets the property 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 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 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_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 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 Amazon Web Services Graviton-based instance types.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5