update changelog

Co-authored-by: Colin Copeland <[email protected]>

Author: HusnaHariz

CHANGELOG.rst

@@ -8,24 +8,30 @@ Change Log
 
 * EBS volume type for worker nodes has been changed from ``gp2`` to ``gp3``. This will result in node replacement. Workload migration should still be managed by AWS.
 
-**What's new in 2.4.0:**
+**What's new in 2.4.0 (#119):**
 
 * **Custom AMI Support**:
+
   * Added support for conditionally specifying custom AMIs for EKS node groups.
   * New parameters:
+
     - ``CustomAMIImageType``: Corresponding image type (e.g., ``AL2023_x86_64_STANDARD``, ``AL2_x86_64``).
     - ``CustomEKSAMI``: AMI ID to use for worker nodes. If ``CustomAMIImageType`` is set, one isn't required to set ``CustomEKSAMI``.
+
   * Conditional logic ensures that these settings are only applied when explicitly provided.
 
 * **Cluster Version Parameterization**:
+
   * Introduced ``EksClusterVersion`` parameter to allow template users to control the Kubernetes version.
   * If this parameter is not set, AWS will default to the version already in place.
 
 * **Launch Template Enhancements**:
+
   * Node group now uses a versioned launch template reference. This will support inplace changes rather than entire nodegroup replacement where possible.
   * Custom AMI ID is injected into the launch template conditionally, based on user input.
 
 * **EBS Improvements**:
+
   * Changed block storage type from ``gp2`` to ``gp3`` in the launch template for better performance and cost optimization.
 
 
@@ -258,6 +264,8 @@ Backwards-incompatible changes:
 * Initial public release
 
 
+.. _2.4.0: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.4.0/
+.. _2.3.0: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.3.0/
 .. _2.2.0: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.2.0/
 .. _2.1.2: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.1.2/
 .. _2.1.1: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.1.1/

stack/eks.py

@@ -108,7 +108,7 @@
 custom_eks_ami = Ref(template.add_parameter(
     Parameter(
         "CustomEKSAMI",
-        Description="Custom AMI ID for EKS node group. Preferably do not set as AWS will select best optimized image if CustomAMIImageType is set.",
+        Description="Custom AMI ID for the EKS node group. It is recommended not to set this value, as AWS will automatically select the most optimized image when CustomAMIImageType is specified.",
         Type="String",
         Default="",
     ),