feat(custom-resources): add optional logging flag to AwsCustomResourceProps
#29596
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
aws-cdk-automation
previously requested changes
Mar 24, 2024
There was a problem hiding this comment.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.
Signed-off-by: Francis <colifran@amazon.com>
colifran
force-pushed
the
colifran/optional-logging
branch
from
775b2d2
to
0122e2d
Compare
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
colifran
changed the title
AwsCustomResourceAwsCustomResource
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Signed-off-by: Francis <colifran@amazon.com>
colifran
changed the title
AwsCustomResourceAwsCustomResource
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
Signed-off-by: Francis <colifran@amazon.com>
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
aws-cdk-automation
added
the
pr/needs-maintainer-review
colifran
changed the title
AwsCustomResourceAwsCustomResourceProps
TheRealAmazonKendra
requested changes
Mar 27, 2024
| /** | ||
| * Inputs to configure the Lambda function response. | ||
| */ | ||
| export interface RespondProps { |
There was a problem hiding this comment.
Suggested change
| export interface RespondProps { | |
| export interface ResponseProps { |
| responseStatus: string; | ||
|
|
||
| /** | ||
| * |
There was a problem hiding this comment.
Missing docstring. What's reason?
| /** | ||
| * API response data to include in the response. | ||
| */ | ||
| data: any; |
There was a problem hiding this comment.
data doesn't make very clear what this actually is.
| * | ||
| * @default false | ||
| */ | ||
| readonly disableLogging?: boolean; |
There was a problem hiding this comment.
A couple things in terms of this prop:
- What if we later want to allow for levels of logging or other logging settings? This doesn't really leave room for that possibility.
- A field that is defaulted to false and is named for the absence of something isn't typically the best way to name/default things.
aws-cdk-automation
removed
the
pr/needs-maintainer-review
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reason for this change
SDK v2 and v3 handlers for
AwsCustomResourcelog the event object passed to the handler, API responses, and caught /uncaught errors. This can potentially result in logging sensitive information that a user may wish to hide. This PR introduces adisableLoggingflag that can be used to disable all logging configured in the SDK v2 and v3 handlers.Description of changes
Added a
disableLoggingflag to theAwsCustomResourcePropsinterface. The value ofdisableLoggingis provided in the handler event object as aResourceProperty. All logging is now logged conditionally based on the value of this property.Description of how you validated changes
disableLoggingset to true was addeddisableLoggingisfalseby defaultdisableLoggingistrueit is set correctly in the synthesized templateChecklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license