Skip to content

Custom AMI

Users can deploy nodes with pre-built Amazon EKS optimized Amazon Machine Images (AMI) or create their own custom AMIs

A custom AMI allows you to make changes to low-level components that are difficult to implement or take a long time to apply in configuration files

Pre-built AMI(s)

To view and use the pre-built latest AMI IDs, refer to Pre-built Amazon EKS optimized AMIs.

Users can launch an instance from an existing AMI, customize the instance and save this updated configuration as a custom AMI. Instances launched from this custom AMI include the customizations made when the AMI was created

All the AMI IDs are mapped to a Kubernetes version, differing for each processor type and regions

AMI IDS

Create AMI ID(s)

Users who do not prefer the existing AMI IDs and require a new Amazon Linux Amazon Machine Image (AMI) to deploy with an Amazon Elastic Kubernetes Service (Amazon EKS) cluster can create a custom AMI ID. Refer Create Amazon EKS Custom AMI for detailed procedure

Custom AMI in Console

Once the required AMI is retrieved, enter the ID in the Nodegroup setting to deploy with an Amazon Elastic Kubernetes Service (Amazon EKS) cluster during the cluster creation

Nodegroup Settings

  • For Bottlerocket based Custom AMI, pass the below parameters via the cluster config file
overrideBootstrapCommand: |
  [Bottlerocket]

An illustrative example of a spec with nodegroup using custom ami of type bottle rocket

managedNodeGroups:
- ami: ami-0aa20e14bc85fd711
  desiredCapacity: 1
  iam:
    withAddonPolicies:
      autoScaler: true
  instanceType: t3.large
  maxSize: 1
  minSize: 1
  name: mngd-Bottle
  overrideBootstrapCommand: |
    [Bottlerocket]
  • For Windows based Custom AMI, pass the below parameters via the cluster config file
overrideBootstrapCommand: |
  [Windows]

An illustrative example of a spec with nodegroup using custom ami of type Windows

nodeGroups
- ami: ami-0f213d8626f4a0ca8
  desiredCapacity: 1
  iam:
    withAddonPolicies:
      autoScaler: true
      imageBuilder: true
  instanceType: t3.large
  maxSize: 1
  minSize: 1
  name: wind
  overrideBootstrapCommand: |
    [Windows]
  volumeSize: 80
  volumeType: gp3
  • For Ubuntu based Custom AMI, pass the below parameters via the cluster config file
overrideBootstrapCommand: |
  [Ubuntu]

An illustrative example of a spec with nodegroup using custom ami of type Ubuntu

nodeGroups
- ami: ami-0f213d8626f4a0ca8
  desiredCapacity: 1
  iam:
    withAddonPolicies:
      autoScaler: true
      imageBuilder: true
  instanceType: t3.large
  maxSize: 1
  minSize: 1
  name: wind
  overrideBootstrapCommand: |
    [Ubuntu]
  volumeSize: 80
  volumeType: gp3