Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GavinZZ committed Jul 15, 2024
1 parent 5c91fa0 commit b5d694c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 14 deletions.
15 changes: 3 additions & 12 deletions packages/aws-cdk-lib/custom-resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ const handler = new lambda.Function(this , 'my-handler', {
});

// Provision a custom resource provider framework
const provider = new Provider(this , 'my-provider', {
const provider = new cr.Provider(this , 'my-provider', {
onEventHandler: handler,
});

Expand All @@ -254,17 +254,8 @@ new CustomResource(this , 'my-cr', {
```

When `NoEcho` field is set to `true` in the response of custom resource handler,
it will automatically mask all values in the `Data` object in the log statements.

```ts
PhysicalResourceId: '1234',
NoEcho: true,
Data: {
mySecret: '*****',
hello: '*****',
ghToken: '*****',
}
```
it will automatically mask all values in the `Data` object in the log statements
to asterisks (*****).

### When there are errors

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,7 @@ interface OnEventResponse {
/**
* Whether to mask the output of the custom resource when retrieved
* by using the `Fn::GetAtt` function. If set to `true`, all returned
* values are masked with asterisks (*****) and to mask the `Data` values
* with asterisks (*****) in the log statements.
* values are masked with asterisks (*****).
*
* @default false
*/
Expand Down

0 comments on commit b5d694c

Please sign in to comment.