feat(custom-resource): add serviceTimeout property for custom resources #30911
Conversation
github-actions
bot
added
effort/medium
aws-cdk-automation
added
the
pr/needs-maintainer-review
| @@ -55,6 +56,13 @@ export interface CustomResourceProps { | |||
| */ | |||
| readonly serviceToken: string; | |||
|
|
|||
| /** | |||
| * The maximum time, in seconds, that can elapse before a custom resource operation times out | |||
There was a problem hiding this comment.
Do we need to mention the unit is seconds here? Since the type is Duration, customers should be able to use different units in Duration.
Also might be good to mention the range is 1 to 3600 seconds here.
There was a problem hiding this comment.
@xazhao
Thanks.
I've updated docs.
| /* | ||
| * Stack verification steps: | ||
| * - Deploy with `--no-clean` | ||
| * - Verify that `ServiceTimeout` is set to 60 in the CloudWatch Logs for the Lambda function that creates custom resources. |
There was a problem hiding this comment.
Curious how did you verify the ServiceTimeout is set to 60?
There was a problem hiding this comment.
Nvm I see you explained it in the PR description.
mazyu36
force-pushed
the
custom-resource-service-timeout-30517
branch
from
df369dc to
d29130b
Compare
|
I don't think we can accept this PR at this time, not because of anything wrong with your code but because of problems with AwsCustomResource. I'm going to put the do-not-close and do-not-merge label on this one while we work to assess whether this is actually safe to accept and/or resolve the other issues at play here. |
TheRealAmazonKendra
added
pr/do-not-merge
|
Ran into wanting this feature (currently waiting for things to timeout hah), what's the concern with |
|
Please prioritize merging this, it's a huge pain point when using Custom Resources in cdk If the custom resource has an unhandled exception, you have no choice but to wait around for an hour |
|
Hello, thanks for pinging us on this issue. I apologize for the delay on the update on this issue. I will sync with Kendra internally and share some update on this PR. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #30911 +/- ##
==========================================
+ Coverage 78.66% 78.67% +0.01%
==========================================
Files 107 107
Lines 7237 7237
Branches 1329 1329
==========================================
+ Hits 5693 5694 +1
+ Misses 1358 1357 -1
Partials 186 186
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Kendra is currently out of office, and I haven’t had a chance to hear back from her yet. I’d like to understand her concerns first before proceeding with the PR review. Thank you for your patience! |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
@GavinZZ , any updates on this? |
Issue # (if applicable)
Closes #30517.
Reason for this change
L2 construct does not support setting
serviceTimeout.Enabling customizable timeouts is useful when using custom resources, as the current default timeout is set to 3600 seconds.
Ref: AWS CloudFormation accelerates dev-test cycle with adjustable timeouts for custom resources
Description of changes
Add
serviceTimeoutproperty forCustomResourceandAwsCustomResource.Description of how you validated changes
Add unit tests and integ tests.
Additionally, I confirmed that ServiceTimeout is set by checking the CloudWatch Logs of the Lambda function that generates custom resources.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license