Wrapper decorators for building CloudFormation custom resources
Project description
cfn-resource-timeout
This project is a decorator and validation system that takes the drudgery out of writing custom resources. You still have access to the context and event as normal, but the decorator handles serializing your response and communicating results to CloudFormation.
See cfn-lambda from Andrew Templeton if you’re looking to write your custom resources in Node.js.
Usage
Copy cfn_resource.py into the directory of your lambda function handler.py, which can be done by installing with pip.
Use the cfn_resource.Resource event decorators to decorate your handler like in example.py
Zip up the contents and upload to Lambda
Once the function is up, copy its ARN and use it as the ServiceToken for your custom resource. For more on the requests you may receive, see this document
{
"AWSTemplateFormatVersion": "2010-09-09",
"Resources": {
"FakeThing": {
"Type": "Custom::MyResource",
"Properties": {
"ServiceToken": "arn:aws:lambda:SOME-REGION:ACCOUNT:function:FunctionName",
"OtherThing": "foobar",
"AnotherThing": 2
}
}
}
}
For more on how custom resources work, see the AWS docs
Code Sample
For this example, you need to have your handler in Lambda set as filename.handler where filename has the below contents.
import cfn_resource
# set `handler` as the entry point for Lambda
handler = cfn_resource.Resource()
@handler.create
def create_thing(event, context):
# do some stuff
return {"PhysicalResourceId": "arn:aws:fake:myID"}
@handler.update
def update_thing(event, context):
# do some stuff
return {"PhysicalResourceId": "arn:aws:fake:myID"}
@handler.delete
def delete_thing(event, context):
# do some stuff
return {"PhysicalResourceId": "arn:aws:fake:myID"}
Running Tests
Install and run tox:
tox
The tests use mock and pytest and will give you a terminal coverage report. Currently the tests cover ~90% of the (very small) codebase.
License
This code is released under the MIT software license, see LICENSE.txt for details. No warranty of any kind is included, and the copyright notice must be included in redistributions.
History
Pending Release
(Insert new release notes below this line)
1.2.0 (2017-05-03)
Move from urllib to requests to fix some encoding errors on Python 3
1.1.0 (2017-04-27)
Added Python 3 compatibility
1.0.0 (2017-03-22)
Forked from RyanSB to Time Out.
Allow rescheduling - by raising the new built-in NoResponse exception, a resource can avoid sending any messing to CloudFormation. This is to support Lambda functions that take >300 seconds to execute and thus reschedule themselves.
0.2.2 (2016-01-29)
Last version by RyanSB.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cfn-resource-timeout-1.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40a28c845fa956c3d280d5de62e7a2fe1beb345aa4be40e4f27df1eaa6de38f0 |
|
MD5 | 339894e4c35d926683c88bd89726a9ab |
|
BLAKE2b-256 | 8a93b316acc91e040ccc776e2881748de71d5c0d77197a73ab50877706109617 |
Hashes for cfn_resource_timeout-1.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 940288f76e5486432a75457d6f76885ada87ee1b8bec17c87117d8ce936bd25d |
|
MD5 | 0777c8089b42719aa44370be73ce3ef1 |
|
BLAKE2b-256 | 3913e3277073a58252a9cc153e4474c1d693a6ea9ea8120198ed465a245e4ca0 |