Skip to main content

A helper lib for lambda based Custom Resources (AWS CloudFormation)

Project description

cfn-custom-resource

Python helper library for creation of Lambda based Custom Resource for AWS CloudFormation. The library allows the author to focus on the logic of creation/update/removal of the Custom Resource instead of the details of the request/response format that CloudFormation expects.

Installation

To install simply use pip:

pip install cfn-custom-resource

Basic usage

Here's how a basic Custom Resource can be created:

from cfn_custom_resource import lambda_handler, create, update, delete

@create()
def create(event, context):
  # .. provision resource ..

  # resource_id = ...
  # output_attribures = {} 

  return resource_id, output_attributes

@update()
def update(event, context):
  # .. update resource ..
  # if resource_id changed cloudformation would trigger delete 

  return resource_id, output_attributes

@delete()
def delete(event, context):
  # .. cleanup ..

  return

Check the wiki for more details.

Contributing

See CONTRIBUTING.md

License

Copyright (c) 2018 Atlassian and others. Apache 2.0 licensed, see LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

cfn_custom_resource-1.0.1-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file cfn_custom_resource-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: cfn_custom_resource-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for cfn_custom_resource-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 de7f428ea7838738a18f7ccf10a3fea71d4edf37dda9b50ad7cd46e784042b5f
MD5 d7a6d03577703af58fb3204f8bb3648f
BLAKE2b-256 16b420bec633e699de3a6ddd2b80816c3715dc6dcd2c2580ef33ebee996f348f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page