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: add service timeout to custom resources #30557

Conversation

prazian
Copy link

@prazian prazian commented Jun 15, 2024

Issue # (if applicable)

Closes #30517.

Reason for this change

CloudFormation recently added the ServiceTimeout property to adjustable timeouts for custom resources:
https://aws.amazon.com/about-aws/whats-new/2024/06/aws-cloudformation-dev-test-cycle-timeouts-custom-resources/

The Cfn documentation can be found here.

Currently, we have the timeout field for the lambda function that creates the resource (here is the cfn docs), but this new field sets timeout on a higher level (I guess).

Description of changes

Even though now it is possible to pass PascalCase properties, adding an explicit property would be more intuitive.

Description of how you validated changes

A new test called "custom timeout" has been added to check the availability of the ServiceTimeout property with the correct value.

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 June 15, 2024 14:21
@github-actions github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p1 labels Jun 15, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

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.

@prazian prazian changed the title feat: Add service timeout to custom resources feat: add service timeout to custom resources Jun 15, 2024
@prazian prazian force-pushed the prazian/feature-add-custom-resource-service-timeout-from-cfn branch from 1a17df3 to 68ff606 Compare June 15, 2024 15:01
@prazian
Copy link
Author

prazian commented Jun 15, 2024

If this is the way to go, please let me know if:

  • I need to create a new integration test or can I can just for example add this field to the VPC integration test?
  • A maintainer needs to run the snapshot test (with credentials to your test account), right?
  • Which docs should be updated?

@GavinZZ
Copy link
Contributor

GavinZZ commented Jun 20, 2024

Hi @prazian, thanks for making contribution to CDK repo.

  1. You will need to create an integration test following this guide https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md#L1. Which VPC test are you talking about? Would you be able to share it so I can help you decide if it's a good place to add test?
  2. You'll need to deploy the newly created integration test. Once it deploys successfully, it will save a snapshot of the Cloud Assembly to local and you can commit that along with your changes. More detail can be found in the guide provided
  3. Generally each module you worked on has a corresponding README file where you can update the doc. In this case, I think this is a pretty good place https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/core/README.md#custom-resources

Feel free to reach out to me and tag me if you have any additional questions

@GavinZZ GavinZZ self-requested a review June 20, 2024 18:26
@prazian prazian marked this pull request as draft June 22, 2024 07:11
@prazian prazian force-pushed the prazian/feature-add-custom-resource-service-timeout-from-cfn branch from 2ee78c2 to 10c5e09 Compare June 22, 2024 08:33
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 10c5e09
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@aws-cdk-automation
Copy link
Collaborator

This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

@aws-cdk-automation
Copy link
Collaborator

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

@aws-cdk-automation aws-cdk-automation added the closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. label Jul 14, 2024
@aws-cdk-automation
Copy link
Collaborator

The pull request linter fails with the following errors:

❌ Features must contain a change to an integration test file and the resulting snapshot.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

custom-resource: Support of ServiceTimeout from Cloudformation
3 participants