Skip to content

Commit 7f6b892

Browse files
authored
docs(synthetics): reference to incorrect property name (#24056)
---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent c7ad66f commit 7f6b892

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Diff for: packages/@aws-cdk/aws-synthetics/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ If you want the canary to run just once upon deployment, you can use `Schedule.o
115115

116116
You can specify whether the AWS CloudFormation is to also delete the Lambda functions and layers used by this canary, when the canary is deleted.
117117

118-
This can be provisioned by setting the `DeleteLambdaResourcesOnCanaryDeletion` property to `true` when we define the canary.
118+
This can be provisioned by setting the `enableAutoDeleteLambdas` property to `true` when we define the canary.
119119

120120
```ts
121121
const stack = new Stack();
@@ -130,8 +130,8 @@ const canary = new synthetics.Canary(stack, 'Canary', {
130130
});
131131
```
132132

133-
Even when set to `true` there are resources such as S3 buckets/logs that do NOT get deleted and are to be deleted manually.
134-
133+
Synthetic Canaries create additional resources under the hood beyond Lambda functions. Setting `enableAutoDeleteLambdas: true` will take care of
134+
cleaning up Lambda functions on deletion, but you still have to manually delete other resources like S3 buckets and CloudWatch logs.
135135

136136
### Configuring the Canary Script
137137

0 commit comments

Comments
 (0)