Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(custom-resource): add serviceTimeout property for custom resources #30911

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

mazyu36
Copy link
Contributor

@mazyu36 mazyu36 commented Jul 20, 2024

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 serviceTimeout property for CustomResource and AwsCustomResource.

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.
スクリーンショット 2024-07-21 2 09 15

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@aws-cdk-automation aws-cdk-automation requested a review from a team July 20, 2024 17:12
@github-actions github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p1 star-contributor [Pilot] contributed between 25-49 PRs to the CDK labels Jul 20, 2024
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jul 20, 2024
@xazhao xazhao self-assigned this Jul 30, 2024
Copy link
Contributor

@xazhao xazhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few minor comments. The code look good to me overall.

@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curious how did you verify the ServiceTimeout is set to 60?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nvm I see you explained it in the PR description.

@mazyu36 mazyu36 force-pushed the custom-resource-service-timeout-30517 branch from df369dc to d29130b Compare July 30, 2024 23:16
@mazyu36 mazyu36 requested a review from xazhao July 31, 2024 00:01
@TheRealAmazonKendra
Copy link
Contributor

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 TheRealAmazonKendra added pr/do-not-merge This PR should not be merged at this time. pr-linter/do-not-close The PR linter will not close this PR while this label is present labels Jul 31, 2024
@polothy
Copy link
Contributor

polothy commented Oct 31, 2024

Ran into wanting this feature (currently waiting for things to timeout hah), what's the concern with AwsCustomResource? The default is still an hour as it always was?

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 41692dc
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p1 pr/do-not-merge This PR should not be merged at this time. pr/needs-maintainer-review This PR needs a review from a Core Team Member pr-linter/do-not-close The PR linter will not close this PR while this label is present star-contributor [Pilot] contributed between 25-49 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

custom-resource: Support of ServiceTimeout from Cloudformation
5 participants