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.14.1
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.14.1.tar.gz | 679.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cdk_factory-1.14.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / cdk_factory-1.14.1.tar.gz
| Download URL | cdk_factory-1.14.1.tar.gz |
|---|---|
| Size | 679.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bc80efd68a39dcc439d4a5de11131e9b66725169725e9924c13d56abbb8fdf52
|
|
BLAKE2b-256 checksum How to use checksums |
9ba45fbd0e91624be7316b46a8bca2caf39b6228a673c1f7113210c3bcbd76e9
|
| 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.1-py3-none-any.whl
| Download URL | cdk_factory-1.14.1-py3-none-any.whl |
|---|---|
| Size | 546.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eb753177746fc23748ad90e640bd6523fbc76a30fac74fb33725a5ddaf617379
|
|
BLAKE2b-256 checksum How to use checksums |
3b790760813a4ca22021550d0f712abcba71c3a7428ca7f7cbc20beaf4259d4d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.2
|
