Skip to main content

cdk-factory

An AWS CDK wrapper for common deployments and best practices.

Contributing to the Code Base

If you are contributing to the code base

  1. Clone this repo
  2. Run the ./setup.sh shell script
  3. Start exploring

Understanding the flow

The core configuration for any of the CDK deployments are controlled in your config.json files. From a high-level we have the following key elements that control the actions within the framework. The details will follow.

key description
cdk Any cdk configs/parameters that you need to pass
workload General information about your workload
workload->stacks A CDK implementation of a CloudFormation Stack
workload->deployments Grouping of Stacks, which can be deployed via stack or pipeline mode
workload->pipelines An AWS Code Pipeline deployment

cdk

The cdk -> parameters defines the following

key description
placeholder A placeholder that will used to perform a fine/replace action in the config once it's processed
env_var_name | value An environment variable to load the value or a static value
cdk_parameter_name The CdkParameterName that will be passed in as custom argument to the synth command

Example

{ 
    "cdk": {
        "parameters": [
            {
                "placeholder": "{{WORKLOAD_NAME}}",
                "env_var_name": "CDK_WORKLOAD_NAME",
                "cdk_parameter_name": "WorkloadName"
            },
            {
                "placeholder": "{{CDK_SYNTH_COMMAND_FILE}}",
                "value": "../../samples/website/commands/cdk_synth.sh",
                "cdk_parameter_name": "CdkSynthCommandFile"
            },
        ]
    }
}

workload

TODO:

stacks

TODO:

deployments

TODO:

pipelines

TODO:

Metadata

Release files for cdk-factory 1.14.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cdk-factory 1.14.6
File Size Uploaded Provenance
cdk_factory-1.14.6.tar.gz 685.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for cdk-factory 1.14.6
File Interpreter ABI Platform
cdk_factory-1.14.6-py3-none-any.whl Python 3 none any Details

Total release size: 1.2 MB

Release files / cdk_factory-1.14.6.tar.gz

Download URL cdk_factory-1.14.6.tar.gz
Size 685.9 kB
Tags Source
SHA-256 checksum
How to use checksums
0864e85833566d9fd48589dac566f4bad0dbc8e9abbe5b516e130dc9fc610dfd
BLAKE2b-256 checksum
How to use checksums
f3e6ed857940ff605623dfac8a9502252b91ca1f3365e7ab23e1c47094bb2f71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Release files / cdk_factory-1.14.6-py3-none-any.whl

Download URL cdk_factory-1.14.6-py3-none-any.whl
Size 554.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
efb48111223a8c0bac28035dece988d23114fafae9e94570199d5733099b71a7
BLAKE2b-256 checksum
How to use checksums
8cd623fdf80786f5d8d32ad99273860cb0f581e65d40b88b606c2558b348d2a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.2

Security for cdk-factory 1.14.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.14.6 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page