Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
Signed-off-by: Francis <colifran@amazon.com>
  • Loading branch information
colifran committed Apr 2, 2024
1 parent b25329a commit 33b18df
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/custom-resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
{
Expand All @@ -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:

```
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand Down

0 comments on commit 33b18df

Please sign in to comment.