AWS CDK Construct Library to manage specific AWS Organization resources
Project description
cdk-library-aws-organization
This CDK library is a WIP and not ready for production use.
Key challenges with Organizations
- Accounts aren't like AWS resources and the removal process isn't a simple delete. Therefore the constructs contained in this library do not have the goal to delete accounts.
- CloudFormation doesn't support Organizations directly so the constructs in this library use CloudFormation custom resources that utilize Python and Boto3
Testing the custom provider code with SAM CLI
- Create a test project that utilizes this library
- Create a test stack
- Synthesize the test stack with
cdk synth --no-staging > template.yml
- Get the function name from the template
- Run
sam local start-lambda -t template.yml
- Run the
handler_tests
python files withpytest
like follows:
LAMBDA_FUNCTION_NAME='<name you noted earlier>' pytest ./handler_tests/<handler>/test.py -rA --capture=sys
- The
test.py
also looks up the root org id to run tests so you'll need to have AWS creds set up to accomodate that behavior. - You can run the provided tests against the real lambda function by getting the deployed function name from AWS and setting the
RUN_LOCALLY
env variable
RUN_LOCALLY='false' LAMBDA_FUNCTION_NAME='<name from AWS>' pytest ./handler_tests/<handler>/test.py -rA --capture=sys
Why can't I move an OU?
Moving OUs isn't supported by Organizations and would cause significant issues with keeping track of OUs in the CDK. Imagine a scenario like below:
-
You have an ou,
OUAdmin
, and it has 2 children,OUChild1 and Account1
, that are also managed by the CDK stack. -
You change the parent of
OUAdmin
toOUFoo
. The CDK would need to take the following actions:-
Create a new
OU
underOUFoo
with the nameOUAdmin
-
Move all of the original
OUAdmin
OU's children to the newOUAdmin
-
Delete the old
OUAdmin
-
Update all physical resource IDs
- It would succeed at moving accounts because physical IDs should not change. Accounting moving between OUs is supported by Organizations
- It would fail at moving any child OUs because they would also be recreated. Resulting in a change to physical resource ID. Because the custom resource can only managed the resource it's currently acting on,
OUAdmin
, any children OUs would be "lost" in this process and ugly to try and manage.
-
The best way to move OUs would be to add additional OUs to your org then move any accounts as needed then proceed to delete the OUs, like so:
- Add new OU resources
- Deploy the stack
- Change account parents
- Deploy the stack
- Remove old OU resources
- Deploy the stack
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for renovosolutions.aws-cdk-aws-organization-0.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61cb106f6a4964465872963457c37d4325b498f96915d7445a3eb15194714ebf |
|
MD5 | ab4eaeb1fef5cdb2484a08fc32c44285 |
|
BLAKE2b-256 | 249a4fe34e43d9244e64807dc71b0d798005f15bcfb1bf54c35afc0b4426fd75 |
Hashes for renovosolutions.aws_cdk_aws_organization-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0eebd6b16b4507be5c1ea1a7effa4652219fbd68018f28cb9ff69094475d0780 |
|
MD5 | af02777aa4fc9b8b1421679a8b8f2df2 |
|
BLAKE2b-256 | 054082863a769acd441e074ed699353f8830136e9bc1a9a0ee2b6d80ea4778d0 |