From 33b18df6f7bcee9a527402537e654602980714f5 Mon Sep 17 00:00:00 2001 From: Francis Date: Mon, 1 Apr 2024 17:06:24 -0700 Subject: [PATCH] documentation updates Signed-off-by: Francis --- packages/aws-cdk-lib/custom-resources/README.md | 4 ++-- .../lib/aws-custom-resource/aws-custom-resource.ts | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/aws-cdk-lib/custom-resources/README.md b/packages/aws-cdk-lib/custom-resources/README.md index 74ce25141ab3a..b25846ae00e90 100644 --- a/packages/aws-cdk-lib/custom-resources/README.md +++ b/packages/aws-cdk-lib/custom-resources/README.md @@ -639,7 +639,7 @@ const getParameter = new cr.AwsCustomResource(this, 'GetParameter', { getParameter.getResponseField('Parameter.Value'); ``` -This would result in the following response object being logged in CloudWatch logs: +This would result in the following response object being logged in CloudWatch Logs: ``` { @@ -653,7 +653,7 @@ This would result in the following response object being logged in CloudWatch lo } ``` -Alternatively, the same example with `logApiResponseData` set to `true` would result in the following response object being logged in CloudWatch logs: +Alternatively, setting `logApiResponseData` to `true` would result in the following response object being logged in CloudWatch Logs: ``` { diff --git a/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts b/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts index ef381986a37cd..542597db3af7c 100644 --- a/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts +++ b/packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts @@ -401,7 +401,7 @@ export interface AwsCustomResourceProps { * If this value is false, the raw API response and the `Data` field in the response * object will be hidden in the lambda logs. * - * A true value logs a response object with the following structure in CloudWatch logs: + * A true value logs a response object with the following structure in CloudWatch Logs: * * { * "Status": "SUCCESS", @@ -422,8 +422,8 @@ export interface AwsCustomResourceProps { * } * } * - * A false value logs a response object with the following structure in CloudWatch logs. - * Note that the Data field depends on the API call that was made: + * A false value logs a response object with the following structure in CloudWatch Logs. + * Note that content in the `Data` field depends on the API call that was made: * * { * "Status": "SUCCESS",