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.12.2
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.12.2.tar.gz | 665.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cdk_factory-1.12.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / cdk_factory-1.12.2.tar.gz
| Download URL | cdk_factory-1.12.2.tar.gz |
|---|---|
| Size | 665.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
70291f1d75b791028bb25b51fb715c9a238ba2bbbb7dc17c25bd0f89e4ca153c
|
|
BLAKE2b-256 checksum How to use checksums |
39d00fed89b9d73663d55ad0c7e68a7dbd622734aab2720989f16cb5aa124d4c
|
| 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.12.2-py3-none-any.whl
| Download URL | cdk_factory-1.12.2-py3-none-any.whl |
|---|---|
| Size | 526.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5d1415c35d351b72c92f05179b850d0726bd85c95b506debb3b8eb07142d4e44
|
|
BLAKE2b-256 checksum How to use checksums |
d56162ac3e17f7e69db3ad0ab7f235039c5b3f6538c458c39d0f050538f2cc77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.2
|
