Package Exports
- @aws-cdk/aws-cloudformation
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-cdk/aws-cloudformation) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
AWS CloudFormation Construct Library
This module is part of the AWS Cloud Development Kit project.
Custom Resources
Custom Resources are CloudFormation resources that are implemented by arbitrary user code. They can do arbitrary lookups or modifications during a CloudFormation synthesis run.
You will typically use Lambda to implement a Construct implemented as a
Custom Resource (though SNS topics can be used as well). Your Lambda function
will be sent a CREATE, UPDATE or DELETE message, depending on the
CloudFormation life cycle. It will perform whatever actions it needs to, and
then return any number of output values which will be available as attributes
of your Construct. In turn, those can be used as input to other Constructs in
your model.
In general, consumers of your Construct will not need to care whether it is implemented in term of other CloudFormation resources or as a custom resource.
Note: when implementing your Custom Resource using a Lambda, use
a SingletonLambda so that even if your custom resource is instantiated
multiple times, the Lambda will only get uploaded once.
Example
The following shows an example of a declaring Custom Resource that copies files into an S3 bucket during deployment (the implementation of the actual Lambda handler is elided for brevity).
The aws-cdk-examples repository has examples for adding custom resources.
References
See the following section of the docs on details to write Custom Resources: