Fix: improving documentation

aws · Apr 9, 2024 · 4940cd1 · 4940cd1
1 parent 7deb69e
commit 4940cd1
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts b/packages/aws-cdk-lib/aws-autoscaling/lib/auto-scaling-group.ts
@@ -83,15 +83,19 @@ export interface CommonAutoScalingGroupProps {
    *
    * `launchTemplate` and `mixedInstancesPolicy` must not be specified when this property is specified
    *
+   * You can either specify `keyPair` or `keyName`, not both.
+   *
    * @default - No SSH access will be possible.
+   * @deprecated - Use `keyPair` instead - https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2-readme.html#using-an-existing-ec2-key-pair
    */
   readonly keyName?: string;
 
   /**
    * The SSH keypair to grant access to the instance.
    *
-   * `keyName`, `launchTemplate` and `mixedInstancesPolicy` must not be specified
-   *  when this property is specified
+   * `launchTemplate` and `mixedInstancesPolicy` must not be specified when this property is specified.
+   *
+   * You can either specify `keyPair` or `keyName`, not both.
    *
    * @default - No SSH access will be possible.
    */