Help improve this page
Want to contribute to this user guide? Scroll to the bottom of this page and select Edit this page on GitHub. Your contributions will help make our user guide better for everyone.
Retrieving Amazon EKS optimized Windows AMI IDs
You can programmatically retrieve the Amazon Machine Image (AMI) ID for Amazon EKS optimized
AMIs by querying the Amazon Systems Manager Parameter Store API. This parameter eliminates the need for
you to manually look up Amazon EKS optimized AMI IDs. For more information about the Systems Manager
Parameter Store API, see GetParameter. The IAM principal that you use must have the
ssm:GetParameter IAM permission to retrieve the Amazon EKS optimized AMI
metadata.
You can retrieve the image ID of the latest recommended Amazon EKS optimized
Windows AMI with the following command, which uses the sub-parameter
image_id. Make the following modifications to the command as needed and
then run the modified command:
-
Replace
release-
Use
2022for Windows Server 2022, but only if you're using Kubernetes version1.24or later. -
Use
2019for Windows Server 2019.
-
-
Replace
installation-option. -
Use
Corefor a minimal installation with a smaller attack surface. -
Use
Fullto include the Windows desktop experience.
-
-
Replace
kubernetes-version -
Replace
region-code
aws ssm get-parameter --name /aws/service/ami-windows-latest/Windows_Server-release-English-installation-option-EKS_Optimized-kubernetes-version/image_id \ --regionregion-code--query "Parameter.Value" --output text
Here's an example command after placeholder replacements have been made.
aws ssm get-parameter --name /aws/service/ami-windows-latest/Windows_Server-2022-English-Core-EKS_Optimized-1.30/image_id \ --regioncn-north-1--query "Parameter.Value" --output text
An example output is as follows.
ami-1234567890abcdef0