amazonka-batch-2.0: Amazon Batch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Batch.Types.Ec2Configuration

Description

 
Synopsis

Documentation

data Ec2Configuration Source #

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.

See: newEc2Configuration smart constructor.

Constructors

Ec2Configuration' 

Fields

  • imageIdOverride :: Maybe Text

    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 :: Maybe Text

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

  • imageType :: Text

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

Instances

Instances details
FromJSON Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

ToJSON Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Generic Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Associated Types

type Rep Ec2Configuration :: Type -> Type #

Read Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Show Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

NFData Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Methods

rnf :: Ec2Configuration -> () #

Eq Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

Hashable Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

type Rep Ec2Configuration Source # 
Instance details

Defined in Amazonka.Batch.Types.Ec2Configuration

type Rep Ec2Configuration = D1 ('MetaData "Ec2Configuration" "Amazonka.Batch.Types.Ec2Configuration" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "Ec2Configuration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageIdOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "imageKubernetesVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newEc2Configuration Source #

Create a value of Ec2Configuration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:imageIdOverride:Ec2Configuration', ec2Configuration_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.

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

$sel:imageType:Ec2Configuration', ec2Configuration_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_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.

ec2Configuration_imageIdOverride :: Lens' Ec2Configuration (Maybe Text) Source #

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.

ec2Configuration_imageKubernetesVersion :: Lens' Ec2Configuration (Maybe Text) Source #

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

ec2Configuration_imageType :: Lens' Ec2Configuration Text Source #

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