feat(custom-resources): provider framework by eladb · Pull Request #4572 · aws/aws-cdk

eladb · 2019-10-17T21:35:55Z

The @aws-cdk/custom-resources.Provider construct is a "mini-framework" for
implementing providers for AWS CloudFormation custom resources. The framework offers a high-level API which makes it easier to implement robust
and powerful custom resources and includes the following capabilities:

Handles responses to AWS CloudFormation and protects against blocked
deployments
Validates handler return values to help with correct handler implementation
Supports asynchronous handlers to enable long operations which can exceed the AWS Lambda timeout

See README file for details.

Fixes #4711
Related #4147

Update README
Support reusing the same handler for onEvent and isComplete.
Add a few more samples

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

`AsyncCustomResource` is a framework for defining robust custom resources. It makes it easy to implement providers for resources that require waiting for the resource to be ready, potentially for time period longer than the AWS Lambda timeout (15min at the moment). When a resource is created, the "begin" operation is invoked, and a state machine is triggered to wait for "complete" to indicate that it's done. It can also indicate that it's still waiting, in which case, Step Functions retry logic will kick in and "complete" will be called thereafter. If retries are exhausted, the resource operation will fail with a timeout. Any exceptions thrown from "begin" or "complete" will be reported as an operation failure to ensure that the custom resource does not hang the stack operation.

mergify · 2019-10-17T21:36:32Z

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

PR title type(scope): text
- type: fix, feat, refactor go into CHANGELOG, chore is hidden
- scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
- text: use all lower-case, do not end with a period, do not include issue refs
PR Description
- Rationale: describe rationale of change and approach taken
- Issues: indicate issues fixed via: fixes #xxx or closes #xxx
- Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
Testing
- Unit test added. Prefer to add a new test rather than modify existing tests
- CLI or init templates change? Re-run/add CLI integration tests
Documentation
- README: update module README to describe new features
- API docs: public APIs must be documented. Copy from official AWS docs when possible
- Design: for significant features, follow design process

aws-cdk-automation · 2019-10-17T21:52:41Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

- change semantics to "onEvent" and "isComplete" - use Lambda layers to load user code - reorg project files

aws-cdk-automation · 2019-10-23T19:53:50Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

* support specifying execution role for each resource instance (very powerful) * always require that on-event will return a physical resource id (to avoid errors) * emit entire stack trace on errors * implement an integration test/sample (S3File)

aws-cdk-automation · 2019-10-29T13:58:00Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-10-29T14:00:11Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

…guage agnostic!

* use RequestId as the name of the state machine execution due to limitations in the name * make handler names required to make sure users are aware that they have to implement them * implement another custom resource in the integration test which "waits" for the object to contain certain contents (tests async resources).

…om-resources

aws-cdk-automation · 2019-11-04T20:35:28Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-11-04T20:47:45Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

packages/@aws-cdk/custom-resources/lib/provider-framework/runtime/framework.ts

packages/@aws-cdk/custom-resources/lib/provider-framework/runtime/util.ts

packages/@aws-cdk/custom-resources/lib/provider-framework/runtime/framework.ts

packages/@aws-cdk/custom-resources/lib/provider-framework/runtime/util.ts

packages/@aws-cdk/custom-resources/lib/provider-framework/runtime/cfn-response.ts

packages/@aws-cdk/custom-resources/lib/provider-framework/runtime/framework.ts

packages/@aws-cdk/custom-resources/lib/provider-framework/runtime/outbound.ts

packages/@aws-cdk/custom-resources/lib/provider-framework/provider.ts

rix0rrr · 2019-11-06T11:21:06Z

Are we marking this @experimental?

eladb · 2019-11-06T12:16:19Z

Are we marking this @experimental?

The whole module is experimental

- remove validation of CFN event (not required) - redesign `failOnError` as `safeHandler` which returns a "safe" cloudformation handler. - fail if user handler returns a non-JSON response.

…om-resources

aws-cdk-automation · 2019-11-06T13:12:08Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-11-06T13:15:02Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

later on we can figure out something smarter if need be

…om-resources

aws-cdk-automation · 2019-11-06T14:58:44Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

aws-cdk-automation · 2019-11-06T14:59:24Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

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

…om-resources

aws-cdk-automation · 2019-11-06T15:46:59Z

AWS CodeBuild CI Report

Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2019-11-06T15:47:35Z

Thank you for contributing! Your pull request is now being automatically merged.

aws-cdk-automation · 2019-11-06T15:48:22Z

AWS CodeBuild CI Report

Result: SUCCEEDED
Build Logs (available for 30 days)

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

whereisaaron · 2022-10-22T23:22:00Z

"How to specify stack creation and rollback timeout? #2125"

Issue #2125 was closed saying it was resolved by this pull request. But how? This seems like an unrelated change?

ryanwilliams83 · 2025-03-23T04:38:31Z

"How to specify stack creation and rollback timeout? #2125"

Issue #2125 was closed saying it was resolved by this pull request. But how? This seems like an unrelated change?

My understanding is that they want us to use the ServiceTimeout property of the AWS::CloudFormation::CustomResource to adjust the timeout on individual custom resources, rather than trying to manipulate the aggregate stack timeout.
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html

SomayaB added the contribution/core This is a PR that came from AWS. label Oct 18, 2019

SomayaB assigned eladb Oct 18, 2019

misc

57609e9

- change semantics to "onEvent" and "isComplete" - use Lambda layers to load user code - reorg project files

eladb removed their assignment Oct 27, 2019

eladb requested review from RomainMuller, nija-at and rix0rrr October 27, 2019 13:52

Elad Ben-Israel added 4 commits October 28, 2019 21:17

move aws-custom-resource to a subdirectory (both lib/ and test/)

9c98197

good test coverage for async custom resource runtime handler

166e410

misc

afb1296

* support specifying execution role for each resource instance (very powerful) * always require that on-event will return a physical resource id (to avoid errors) * emit entire stack trace on errors * implement an integration test/sample (S3File)

add failing test

46378d5

NGL321 assigned eladb Oct 29, 2019

Elad Ben-Israel added 4 commits October 31, 2019 10:43

remove support for resource-specific roles

03c1495

extract user handlers to separate lambdas, which means we are now lan…

b10b520

…guage agnostic!

rename to ProviderFramework and add README

0f746b2

eladb changed the title ~~feat(custom-resources): async custom resources~~ feat(custom-resources): custom resources provider framework Nov 4, 2019

add types.d

cb86b09

eladb marked this pull request as ready for review November 4, 2019 20:25

Merge remote-tracking branch 'origin/master' into benisrae/async-cust…

9492cff

…om-resources

a bunch of minor fixes

822f791

eladb changed the title ~~feat(custom-resources): custom resources provider framework~~ feat(custom-resources): provider framework Nov 4, 2019

rix0rrr reviewed Nov 6, 2019

View reviewed changes

update README

96cccf8

Elad Ben-Israel added 2 commits November 6, 2019 14:45

code review fixes

ae5d26c

- remove validation of CFN event (not required) - redesign `failOnError` as `safeHandler` which returns a "safe" cloudformation handler. - fail if user handler returns a non-JSON response.

Merge remote-tracking branch 'origin/master' into benisrae/async-cust…

829a444

…om-resources

rix0rrr added the pr/do-not-merge This PR should not be merged at this time. label Nov 6, 2019

rix0rrr approved these changes Nov 6, 2019

View reviewed changes

Elad Ben-Israel added 3 commits November 6, 2019 15:44

fix docstring in aws-cloudformation

7f7e169

set all framework timeouts to 15min

47d6e70

later on we can figure out something smarter if need be

add a section about error handling

1e99e6d

eladb removed the pr/do-not-merge This PR should not be merged at this time. label Nov 6, 2019

Merge remote-tracking branch 'origin/master' into benisrae/async-cust…

5c50eda

…om-resources

Elad Ben-Israel added 2 commits November 6, 2019 17:21

pass modules in topological order during packaging

46d600b

Merge remote-tracking branch 'origin/master' into benisrae/async-cust…

e3ef8de

…om-resources

mergify bot merged commit f9eec04 into master Nov 6, 2019

mergify bot deleted the benisrae/async-custom-resources branch November 6, 2019 15:47

eladb mentioned this pull request Nov 11, 2019

How to specify stack creation and rollback timeout? #2125

Closed

mcalello mentioned this pull request Jan 31, 2020

Speed up custom resource development #4711

Closed

damnhandy mentioned this pull request Mar 26, 2023

aws-cdk-lib: Expose the ability to set a stack timeout to CloudFormation #24792

Open

2 tasks

Conversation

eladb commented Oct 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mergify bot commented Oct 17, 2019

Uh oh!

aws-cdk-automation commented Oct 17, 2019

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Oct 23, 2019

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Oct 29, 2019

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Oct 29, 2019

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Nov 4, 2019

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Nov 4, 2019

AWS CodeBuild CI Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rix0rrr commented Nov 6, 2019

Uh oh!

eladb commented Nov 6, 2019

Uh oh!

aws-cdk-automation commented Nov 6, 2019

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Nov 6, 2019

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Nov 6, 2019

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Nov 6, 2019

AWS CodeBuild CI Report

Uh oh!

aws-cdk-automation commented Nov 6, 2019

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Nov 6, 2019

Uh oh!

aws-cdk-automation commented Nov 6, 2019

AWS CodeBuild CI Report

Uh oh!

whereisaaron commented Oct 22, 2022

Uh oh!

ryanwilliams83 commented Mar 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

eladb commented Oct 17, 2019 •

edited

Loading

ryanwilliams83 commented Mar 23, 2025 •

edited

Loading