Help improve this page
To contribute to this user guide, choose the Edit this page on GitHub link that is located in the right pane of every page.
Retrieve recommended Microsoft Windows AMI IDs
When deploying nodes, you can specify an ID for a pre-built Amazon EKS optimized Amazon Machine Image (AMI). To retrieve an AMI ID that fits your desired configuration, query the Amazon Systems Manager Parameter Store API. Using this API eliminates the need to manually look up Amazon EKS optimized AMI IDs. For more information, 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
releasewith one of the following options.-
Use
2022for Windows Server 2022. -
Use
2019for Windows Server 2019.
-
-
Replace
installation-optionwith one of the following options. For more information, see What is the Server Core installation option in Windows Server. -
Use
Corefor a minimal installation with a smaller attack surface. -
Use
Fullto include the Windows desktop experience.
-
-
Replace
kubernetes-versionwith a supported Amazon EKS version. -
Replace
region-codewith an Amazon EKS supported Amazon Region for which you want the AMI ID.
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-k8s-n-2/image_id \ --regionus-west-2--query "Parameter.Value" --output text
An example output is as follows.
ami-1234567890abcdef0