Skip to main content

AWS CDK construct for AWS Chalice

Project description

cdk-chalice

PyPI Version PythonSupport PyPI status Downloads Build Status codecov Quality Gate Status Code style: black Contributors

AWS CDK construct for AWS Chalice

This library allows to include an AWS Chalice application into a broader AWS Cloud Development Kit (AWS CDK) application.

The following approach to AWS CDK and AWS Chalice interoperability is taken by the library:

  1. Manually create Chalice application (chalice new-project) with default "dev" stage in .chalice/config.json. cdk-chalice library could perform this Chalice application scaffolding automatically - create new project, or skip this step if project already exists in the target directory (this is chalice new-project behavior). The choice to keep this step manual (for now) was made to hopefully make adoption easier for developers who already have existing Chalice projects.

  2. Manually create CDK application (cdk init [ARGS])

  3. Use cdk_chalice.Chalice class to generate stage per CDK stack in .chalice/config.json and run chalice package. This is the main purpose of cdk-chalice - allow passing CDK tokens for resources, such as DynamoDB table, to SAM template generated by chalice package (see example here), and also to automate the packaging process itself.

If AWS Chalice doesn't support certain options through its configuration mechanism, there are two ways to address this:

  • Open an issue for AWS Chalice
  • Customize the resources after they have been imported into the CDK stack. cdk-chalice uses AWS CDK cloudformation-include module to enable customization. See cdk-chalice API documentation for example and additional details.

The API documentation and usage example are available at https://cdk-chalice.softwhat.com/

Installation

Install and update using pip:

pip install -U cdk-chalice

Project details


Download files

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

Source Distribution

cdk-chalice-0.9.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cdk_chalice-0.9.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file cdk-chalice-0.9.0.tar.gz.

File metadata

  • Download URL: cdk-chalice-0.9.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.1

File hashes

Hashes for cdk-chalice-0.9.0.tar.gz
Algorithm Hash digest
SHA256 66f4b61f769b2b2fedb762f10e59484d978c6bac727524f2ea1e907b4d7cc569
MD5 a2ceea56813057d94976fd9d4db29d61
BLAKE2b-256 b40d0f71341b59024677cdf531c6d8840e3150ee6569cf9e283e79a14aa84e37

See more details on using hashes here.

File details

Details for the file cdk_chalice-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: cdk_chalice-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.7.1

File hashes

Hashes for cdk_chalice-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2174d10f0d3d7f25e44b00faa9020f801d9c4c96c3e4fdd8d7dbd3a2fa81ef9d
MD5 83a2e9dbe2f78a6b9bc72ada053ab264
BLAKE2b-256 d8f8e27bc7bcf1e740c6df874f5ea46c7435e43cb04ae8377326057d24c2f3d2

See more details on using hashes here.

Supported by

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