Skip to main content

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

Project description


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.


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

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

  # resource_id = ...
  # output_attribures = {} 

  return resource_id, output_attributes

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

  return resource_id, output_attributes

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


Check the wiki for more details.




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

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page