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:
1 maintainer
Metadata
1 maintainer
Release files for cdk-factory 1.13.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cdk_factory-1.13.0.tar.gz | 675.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cdk_factory-1.13.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / cdk_factory-1.13.0.tar.gz
| Download URL | cdk_factory-1.13.0.tar.gz |
|---|---|
| Size | 675.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4b4a3c67998e25b4eec9613d59dfa3264f257cdff1db381adb0af9d5594e6714
|
|
BLAKE2b-256 checksum How to use checksums |
7965dee6687a7317d6c85b1c79b240cd20e2cdbb2467361b3f4ab99c88904c22
|
| 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.13.0-py3-none-any.whl
| Download URL | cdk_factory-1.13.0-py3-none-any.whl |
|---|---|
| Size | 539.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2d66c352ce4c36f6bea472bf04e276f56b8212e3b0bc9d7c40397f3446494376
|
|
BLAKE2b-256 checksum How to use checksums |
561a1afd68eec60362bb0e116b334e36152593e54decebaa794a128d573efed6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.2
|
