chore: updated field docs about allowed launch template and AMI type …

…combinations
aws · Aug 12, 2024 · 37adee8 · 37adee8
1 parent 57e282f
commit 37adee8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/packages/aws-cdk-lib/aws-eks/README.md b/packages/aws-cdk-lib/aws-eks/README.md
@@ -227,7 +227,8 @@ cluster.addNodegroupCapacity('custom-node-group', {
 });
 ```
 
-To use a custom AMI for the node group, you can set `amiType` to `eks.NodegroupAmiType.CUSTOM` and provide a launch template.
+To use a custom AMI for the node group, you can set `amiType` to `CUSTOM`.
+A launch template must be provided.
 
 ```ts
 declare const cluster: eks.Cluster;

diff --git a/packages/aws-cdk-lib/aws-eks/lib/managed-nodegroup.ts b/packages/aws-cdk-lib/aws-eks/lib/managed-nodegroup.ts
@@ -197,8 +197,8 @@ export interface NodegroupOptions {
    */
   readonly subnets?: SubnetSelection;
   /**
-   * The AMI type for your node group. If you explicitly specify the launchTemplate with custom AMI, do not specify this property, or
-   * the node group deployment will fail. In other cases, you will need to specify correct amiType for the nodegroup.
+   * The AMI type for your node group. If you explicitly specify the launchTemplate with custom AMI, either set this property to `CUSTOM` or leave
+   * it undefined, otherwise the node group deployment will fail. In other cases, you will need to specify correct amiType for the nodegroup.
    *
    * @default - auto-determined from the instanceTypes property when launchTemplateSpec property is not specified
    */
@@ -296,7 +296,9 @@ export interface NodegroupOptions {
    */
   readonly tags?: { [name: string]: string };
   /**
-   * Launch template specification used for the nodegroup
+   * Launch template specification used for the nodegroup.
+   * Required when `amiType` is set to `CUSTOM`.
+   *
    * @see https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html
    * @default - no launch template
    */