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
- Clone this repo
- Run the
./setup.shshell script - 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.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cdk_factory-1.14.5.tar.gz | 685.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cdk_factory-1.14.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / cdk_factory-1.14.5.tar.gz
| Download URL | cdk_factory-1.14.5.tar.gz |
|---|---|
| Size | 685.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
306f08178dd297e0274e8e29330ccbfed01593e2441db673143eb3cc141c7f78
|
|
BLAKE2b-256 checksum How to use checksums |
229db98cea3b02056190f777ae5e6e3e9287efd4b2cb1b228ecb9341c84a95cf
|
| 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.5-py3-none-any.whl
| Download URL | cdk_factory-1.14.5-py3-none-any.whl |
|---|---|
| Size | 553.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
10e8c4f2eb6c756a39c61a415ce95cf31298785e5de07c5ce67a08c843abaa97
|
|
BLAKE2b-256 checksum How to use checksums |
77156025dd173ec34ed5cb6d5aa9778856d4d077407cdcbb6e1b46eb2715533d
|
| 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.5
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.