Repository navigation
Commit b049064
authored
### Reason for this change
SDK v2 and v3 handlers for `AwsCustomResource` log the event object passed to the handler, API responses, and caught /uncaught errors for each SDK call made. This can potentially result in logging sensitive information that a user may wish to hide. This PR introduces a new `logging` property on the `AwsSdkCall` interface that can be used to provide more control over logging in the SDK v2 and v3 handlers on a per SDK call basis. The `logging` flag is configurable via a new `Logging` class which exposes two static methods:
- all: all logging during lambda execution is turned on
- withDataHidden: hides all logged data associated with the API call response. This includes the raw response as well as the `Data` field on the response object
Additional logging configurations can be added in the future.
### Description of changes
Added a `logging` flag to the `AwsSdkCall` interface which is configurable via the new `Logging` class. The `Logging` class has an internal `render` method which renders the specified logging configuration which is passed as part of the `create`, `update`, and `delete` `ResourceProperties` to the lambda handler. These `logging` properties are then used throughout the handler to control what is logged based on their value
### Description of how you validated changes
* A new integ test with `logging` as `withDataHidden` was added
* Unit tests to ensure calling `render` on a `Logging` instance produces the expected result
* Unit tests to ensure that using `logging` with `AwsSdkCall` while using `AwsCustomResource` produces the correct CloudFormation template
### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent f10494c commit b049064
299 files changed
Lines changed: 69164 additions & 108364 deletions
File tree
- packages
- @aws-cdk-testing/framework-integ/test
- aws-codedeploy/test/lambda/integ.deployment-config.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.e5178afc49b7c6a85127a67856ce958e4f0879ce6aad5e974cac2a088bf939db
- aws-cognito/test
- integ.user-pool-client-explicit-props.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.e5178afc49b7c6a85127a67856ce958e4f0879ce6aad5e974cac2a088bf939db
- integ.user-pool-client-secret.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.e5178afc49b7c6a85127a67856ce958e4f0879ce6aad5e974cac2a088bf939db
- integ.user-pool-domain-cfdist.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.e5178afc49b7c6a85127a67856ce958e4f0879ce6aad5e974cac2a088bf939db
- aws-elasticloadbalancingv2-actions/test/integ.cognito.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- asset.d0261fb8def1b1203d12c24e8c86739f09d83136c79f45521f3739d1cb568887.bundle
- aws-elasticloadbalancingv2/test/integ.alb.oidc.js.snapshot
- asset.1b474110b3f79050ba8693912584a5d5bac8c7e94d63afa8c73f1d087444e7cc
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.4984c845346313a408899c8ff361d3b7b97953a9d4202e47694ef2a101f4b5c3.bundle
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- asset.d0261fb8def1b1203d12c24e8c86739f09d83136c79f45521f3739d1cb568887.bundle
- aws-elasticsearch/test
- integ.elasticsearch.custom-kms-key.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- integ.elasticsearch.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.e5178afc49b7c6a85127a67856ce958e4f0879ce6aad5e974cac2a088bf939db
- integ.elasticsearch.unsignedbasicauth.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- aws-events-targets/test/logs/integ.log-group.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- asset.d0261fb8def1b1203d12c24e8c86739f09d83136c79f45521f3739d1cb568887.bundle
- aws-globalaccelerator-endpoints/test/integ.globalaccelerator.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- aws-globalaccelerator/test/integ.globalaccelerator-endpoints.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- aws-logs-destinations/test/integ.lambda.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- asset.d0261fb8def1b1203d12c24e8c86739f09d83136c79f45521f3739d1cb568887.bundle
- aws-opensearchservice/test
- integ.opensearch.custom-kms-key.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- integ.opensearch.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- integ.opensearch.unsignedbasicauth.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- aws-route53/test/integ.vpc-endpoint-service-domain-name.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- aws-s3/test/integ.bucket-auto-delete-objects.js.snapshot
- asset.1b474110b3f79050ba8693912584a5d5bac8c7e94d63afa8c73f1d087444e7cc
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- aws-stepfunctions-tasks/test/emrcontainers
- integ.start-job-run.js.snapshot
- asset.1471fa6f2876749a13de79989efc6651c9768d3173ef5904947e87504f8d7069
- apply
- get
- helm
- patch
- asset.15197a5512179542fe2cff74af89bb047793c9c4e0b4395f114641a81cd52ae5
- asset.1b474110b3f79050ba8693912584a5d5bac8c7e94d63afa8c73f1d087444e7cc
- asset.1b5aaa158e02216aa983cbf998d740faf1176f70b3769f77295e9bd20f543edf
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.8dd602cf5aa1420570d23fd9ec2d7b613ac9861fe0fd0a1fd5f8bbd65b5d3abd
- asset.c014eecccbb25b3f9b2930f62990f5a373bb117a6c78807df15d78a5ac33e9cd
- aws-synthetics/test
- integ.canary-auto-delete-lambda.js.snapshot
- custom-resources/test/aws-custom-resource
- integ.aws-custom-resource-athena.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- integ.aws-custom-resource-ssm.js.snapshot
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- integ.aws-custom-resource-vpc.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- integ.aws-custom-resource.js.snapshot
- asset.482f9f5ffd706706c8ef3652699d6c945568786593d3571e4331ecb1f966c932
- asset.746da84b10e215c552e68b6d2061024e4429f0386f43a35ef5e4d2940655692e
- integ.cross-account-assumeRole.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.b0de6372e1c756b7afa1a8a1d0a21ee4cd330150290abffc9bc163f285150514
- integ.invoke-function-payload.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.e5178afc49b7c6a85127a67856ce958e4f0879ce6aad5e974cac2a088bf939db
- @aws-cdk
- aws-glue-alpha/test/integ.partition-index.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.e5178afc49b7c6a85127a67856ce958e4f0879ce6aad5e974cac2a088bf939db
- aws-iot-actions-alpha/test/opensearch/integ.open-search-action.js.snapshot
- asset.1b474110b3f79050ba8693912584a5d5bac8c7e94d63afa8c73f1d087444e7cc
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- aws-msk-alpha/test
- integ.add-cluster-user.js.snapshot
- asset.211bd8c514e07e047addb5c06afe6f8e85ce4e0b19b64ad78b28e84fc09aafe7.bundle
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.b0de6372e1c756b7afa1a8a1d0a21ee4cd330150290abffc9bc163f285150514
- asset.d0261fb8def1b1203d12c24e8c86739f09d83136c79f45521f3739d1cb568887.bundle
- integ.cluster-zookeeper.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.b0de6372e1c756b7afa1a8a1d0a21ee4cd330150290abffc9bc163f285150514
- integ.cluster.js.snapshot
- asset.2ec8ad9e91dcd6e7ad6a5c84ffc6c9c05c408aca3b26ceb2816d81043e6c4dc3
- asset.54e6f07bf3aea46d100719f3b21fe0fb45ae789ee372d42d8cdfb97e21aba96c
- asset.63ae5d5f48d3638501e722718b99b5f2fddb9ab73a15d7cb607215a500df19e1.bundle
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.d0261fb8def1b1203d12c24e8c86739f09d83136c79f45521f3739d1cb568887.bundle
- asset.e5178afc49b7c6a85127a67856ce958e4f0879ce6aad5e974cac2a088bf939db
- aws-redshift-alpha/test/integ.cluster-defaultiamrole.js.snapshot
- asset.6c34b6e864223e202d50bb862e2bf066393d4cdf36229f8e1646425a5224a10b
- asset.e5178afc49b7c6a85127a67856ce958e4f0879ce6aad5e974cac2a088bf939db
- custom-resource-handlers/lib/custom-resources/aws-custom-resource-handler
- aws-cdk-lib
- aws-codedeploy/test/lambda
- aws-cognito/test
- aws-elasticsearch/test
- aws-events-targets/test/logs
- aws-globalaccelerator/test
- aws-opensearchservice/test
- aws-route53/test
- aws-stepfunctions-tasks/test/emrcontainers
- custom-resources
- lib/aws-custom-resource
- test/aws-custom-resource
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
26 | | - | |
27 | | - | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
98 | | - | |
| 98 | + | |
99 | 99 | | |
100 | 100 | | |
101 | 101 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments