CloudFormation Drift Remediation
Installation
This package is available on pypi, you can for example use on of these commands (pipx is recommended)
pipx install cfn-drift-remediation
pip install cfn-drift-remediation
Usage
- Run drift detection on a stack, and verify that you want to remediate it by changing the provisioned resource (using the stack as the source of truth).
- run one of the commands below
- Run drift detection again to verify that everything is in sync again.
# Default usage
cfn-drift-remediation stack_name
# Using a different profile
AWS_DEFAULT_PROFILE=profile-name cfn-drift-remediation stack_name
# Using a third party tool like aws-vault
aws-vault exec profile-name -- cfn-drift-remediation stack_name
How this works
This tool will read the existing drift of a stack, iterate through the drifted resources and construct a patch document to change the actual (detected) property values to the expected (stack) values.
Caveats
- Changes are done with CloudControl API. This does mean that if the drifted resources do not support Cloud Control API, they will be skipped.
- For some resources the order in a list does not matter, this might lead to a failure to apply changes, because Cloud Control API will assume the resource is not in the drifted state it expects.
- We do not support creating resources that were completely deleted from the stack. The drift detection api does not return enough information to construct the replacement resource.
Development
We use poetry to manage this project
- Clone this repository
- Run
poetry install - Activate the virtualenvironment with
poetry shell(you can also usepoetry run $command)
Releasing a new version to pypi
- Edit pyproject.toml to update the version number
- Edit cfn_drift_remediation/_init.py to update the version number
- Commit the version number bump
- Run tests
poetry run pytest(you might have to install dependencies withpoetry install --dev) - Run
poetry publish --build - Push to GitHub
- Create a new release in GitHub
Using poetry in Visual Studio Code
If you want to use poetry in Visual Studio Code, it works best if the virtual environment is created inside the project folder. Once the virtual environment is created, you can run the "Python: Select interpreter" command in Visual Studio Code, and point to the .venv folder.
poetry config virtualenvs.in-project true
If you already created the virtual environment, you have to recreate it
# from within the project folder
poetry env remove $(poetry env list)
poetry install
20 Jun 18, 2022
10 Aug 18, 2022
6 Mar 31, 2022
16 Nov 24, 2022
11 Dec 17, 2022
31 Nov 21, 2022
7 Feb 15, 2022
51 Dec 10, 2022
2 Jan 25, 2022
1 Feb 05, 2022
2 Nov 04, 2021
2 Mar 10, 2022
30 Dec 04, 2022
8 Aug 10, 2022
95 Dec 25, 2022
6 Apr 02, 2022
8 Aug 09, 2022
23 Oct 21, 2022
206 May 01, 2022
2 Jul 25, 2022
215 Dec 23, 2022
1 Dec 15, 2021
3 Nov 17, 2021
655 Jan 03, 2023
511 Dec 30, 2022
244 Nov 30, 2022
18 Dec 20, 2022
187 Dec 20, 2022