Apply suggestions from code review

Co-authored-by: Luca Pizzini <[email protected]>
aws · Jan 7, 2024 · 4164be0 · 4164be0
1 parent dd300d0
commit 4164be0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/packages/aws-cdk-lib/aws-certificatemanager/README.md b/packages/aws-cdk-lib/aws-certificatemanager/README.md
@@ -158,9 +158,12 @@ new acm.Certificate(this, 'Certificate', {
 
 ## Key Algorithms
 
-The [key algorithm](https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms.title) can be specified
-for each key. Only some values (highlighted in the linked article) are supported for certificate
-requests.
+To specify the algorithm of the public and private key pair that your certificate uses to encrypt data use the `keyAlgorithm` property.
+
+Algorithms supported for an ACM certificate request include:
+ * `RSA_2048`
+ * `EC_prime256v1`
+ * `EC_secp384r1`
 
 ```ts
 new acm.Certificate(this, 'Certificate', {
@@ -169,6 +172,8 @@ new acm.Certificate(this, 'Certificate', {
 });
 ```
 
+> Visit [Key algorithms](https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms.title) for more details.
+
 ## Importing
 
 If you want to import an existing certificate, you can do so from its ARN:

diff --git a/packages/aws-cdk-lib/aws-certificatemanager/lib/certificate.ts b/packages/aws-cdk-lib/aws-certificatemanager/lib/certificate.ts
@@ -114,7 +114,7 @@ export interface CertificateProps {
    *
    * @see https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms.title
    *
-   * @default the CloudFormation default (RSA 2048 bit)
+   * @default - `RSA_2048`
    */
   readonly keyAlgorithm?: KeyAlgorithm;
 }