[![NPM version](https://badge.fury.io/js/cdk-organizations-list-accounts.svg)](https://badge.fury.io/js/cdk-organizations-list-accounts)
[![PyPI version](https://badge.fury.io/py/cdk-organizations-list-accounts.svg)](https://badge.fury.io/py/cdk-organizations-list-accounts)
![Release](https://github.com/hayao-k/cdk-organizations-list-accounts/workflows/release/badge.svg)
# cdk-organizations-list-accounts
Want to keep an up-to-date list of your AWS accounts?
cdk-organizations-list-accounts is an AWS CDK building library that outputs a list of AWS organization accounts in CSV format.
## Overview
Amazon EventBridge detects the account creation event and starts a Lambda function.
An accounts list, including the organization structure, will be output to S3 bucket in CSV format.
Output Example:
```csv
Id,Name,Email,Status,Joined Method,Joined Timestamp,OU Id,1st Level OU,2nd Level OU,3rd Level OU,4th Level OU,5th Level OU
000000000000,account-mgmt,account+mgmt@example.com,ACTIVE,INVITED,2022-01-31 07:19:57,r-xxxx
111111111111,account-0001,account+0001@example.com,ACTIVE,INVITED,2022-01-31 07:25:38,ou-xxxx-yyyyyyyy,Suspended
222222222222,account-0002,account+0002@example.com,ACTIVE,CREATED,2022-01-31 07:31:28,ou-xxxx-zzzzzzzz,Sample System,Additional,Workloads,Prod
333333333333,account-0003,account+0003@example.com,ACTIVE,CREATED,2022-01-31 08:15:49,ou-xxxx-zzzzzzzz,Sample System,Additional,Workloads,SDLC
444444444444,account-0004,account+0004@example.com,ACTIVE,CREATED,2022-01-31 09:18:50,ou-xxxx-zzzzzzzz,Sample System,Foundational,Security,Prod
555555555555,account-0005,account+0005@example.com,ACTIVE,CREATED,2022-01-31 10:21:30,ou-xxxx-zzzzzzzz,Sample System,Foundational,Infrastructure,Prod
666666666666,account-0006,account+0006@example.com,ACTIVE,CREATED,2022-01-31 11:21:05,ou-xxxx-zzzzzzzz,Sample System,Foundational,Infrastructure,SDLC
```
## Limitations at present
* Must deploy to AWS Organization's management account
* Events other than CreateAccount are not supported
## Getting Started
### TypeScript
Installation
```
$ yarn add cdk-organizations-list-accounts
```
Usage
```python
import * as cdk from 'aws-cdk-lib';
import { OrganizationsListAccounts } from 'cdk-organizations-list-accounts';
const App = new cdk.App();
const stack = new cdk.Stack(App, 'Stack', { env: { region: 'us-east-1' } });
new OrganizationsListAccounts(stack, 'Organizations-List-Accounts');
```
Deploy!
```
$ cdk deploy
```
### Python
Installation
```
$ pip install cdk-organizations-list-accounts
```
Usage
```py
import aws_cdk as cdk
from cdk_organizations_list_accounts import OrganizationsListAccounts
app = cdk.App()
stack = cdk.Stack(app, "Stack", env={"region": "us-east-1"})
OrganizationsListAccounts(stack, "Organizations-List-Accounts")
app.synth()
```
Deploy!
```
$ cdk deploy
```
Raw data
{
"_id": null,
"home_page": "https://github.com/hayao-k/cdk-organizations-list-accounts.git",
"name": "cdk-organizations-list-accounts",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "hayao-k<30886141+hayao-k@users.noreply.github.com>",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f6/82/a3790e4798ad9bbe5ca101e3a536228803b7b60015ca0e1c2f683f3a7b8b/cdk-organizations-list-accounts-1.0.355.tar.gz",
"platform": null,
"description": "[![NPM version](https://badge.fury.io/js/cdk-organizations-list-accounts.svg)](https://badge.fury.io/js/cdk-organizations-list-accounts)\n[![PyPI version](https://badge.fury.io/py/cdk-organizations-list-accounts.svg)](https://badge.fury.io/py/cdk-organizations-list-accounts)\n![Release](https://github.com/hayao-k/cdk-organizations-list-accounts/workflows/release/badge.svg)\n\n# cdk-organizations-list-accounts\n\nWant to keep an up-to-date list of your AWS accounts?\n\ncdk-organizations-list-accounts is an AWS CDK building library that outputs a list of AWS organization accounts in CSV format.\n\n## Overview\n\nAmazon EventBridge detects the account creation event and starts a Lambda function.\nAn accounts list, including the organization structure, will be output to S3 bucket in CSV format.\n\nOutput Example:\n\n```csv\nId,Name,Email,Status,Joined Method,Joined Timestamp,OU Id,1st Level OU,2nd Level OU,3rd Level OU,4th Level OU,5th Level OU\n000000000000,account-mgmt,account+mgmt@example.com,ACTIVE,INVITED,2022-01-31 07:19:57,r-xxxx\n111111111111,account-0001,account+0001@example.com,ACTIVE,INVITED,2022-01-31 07:25:38,ou-xxxx-yyyyyyyy,Suspended\n222222222222,account-0002,account+0002@example.com,ACTIVE,CREATED,2022-01-31 07:31:28,ou-xxxx-zzzzzzzz,Sample System,Additional,Workloads,Prod\n333333333333,account-0003,account+0003@example.com,ACTIVE,CREATED,2022-01-31 08:15:49,ou-xxxx-zzzzzzzz,Sample System,Additional,Workloads,SDLC\n444444444444,account-0004,account+0004@example.com,ACTIVE,CREATED,2022-01-31 09:18:50,ou-xxxx-zzzzzzzz,Sample System,Foundational,Security,Prod\n555555555555,account-0005,account+0005@example.com,ACTIVE,CREATED,2022-01-31 10:21:30,ou-xxxx-zzzzzzzz,Sample System,Foundational,Infrastructure,Prod\n666666666666,account-0006,account+0006@example.com,ACTIVE,CREATED,2022-01-31 11:21:05,ou-xxxx-zzzzzzzz,Sample System,Foundational,Infrastructure,SDLC\n```\n\n## Limitations at present\n\n* Must deploy to AWS Organization's management account\n* Events other than CreateAccount are not supported\n\n## Getting Started\n\n### TypeScript\n\nInstallation\n\n```\n$ yarn add cdk-organizations-list-accounts\n```\n\nUsage\n\n```python\nimport * as cdk from 'aws-cdk-lib';\nimport { OrganizationsListAccounts } from 'cdk-organizations-list-accounts';\n\nconst App = new cdk.App();\nconst stack = new cdk.Stack(App, 'Stack', { env: { region: 'us-east-1' } });\nnew OrganizationsListAccounts(stack, 'Organizations-List-Accounts');\n```\n\nDeploy!\n\n```\n$ cdk deploy\n```\n\n### Python\n\nInstallation\n\n```\n$ pip install cdk-organizations-list-accounts\n```\n\nUsage\n\n```py\nimport aws_cdk as cdk\nfrom cdk_organizations_list_accounts import OrganizationsListAccounts\n\napp = cdk.App()\nstack = cdk.Stack(app, \"Stack\", env={\"region\": \"us-east-1\"})\nOrganizationsListAccounts(stack, \"Organizations-List-Accounts\")\napp.synth()\n```\n\nDeploy!\n\n```\n$ cdk deploy\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "cdk-organizations-list-accounts is an AWS CDK building library that outputs a list of AWS organization accounts in CSV format.",
"version": "1.0.355",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "de78354fb19cc6d6b818b20acb0326cc97c5c9c4af2a5d894df22ca069404a5e",
"md5": "bc2acb320f5362f72ce227a90e616a09",
"sha256": "adf5e8866081c494691663f6e70285ce2746bcb90983c4b0f84911b6ef5a9a19"
},
"downloads": -1,
"filename": "cdk_organizations_list_accounts-1.0.355-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc2acb320f5362f72ce227a90e616a09",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 29074,
"upload_time": "2023-03-20T01:10:00",
"upload_time_iso_8601": "2023-03-20T01:10:00.127141Z",
"url": "https://files.pythonhosted.org/packages/de/78/354fb19cc6d6b818b20acb0326cc97c5c9c4af2a5d894df22ca069404a5e/cdk_organizations_list_accounts-1.0.355-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f682a3790e4798ad9bbe5ca101e3a536228803b7b60015ca0e1c2f683f3a7b8b",
"md5": "c511a3df330dd4982b622d95a620b630",
"sha256": "870c41f41b14271588aaf97a3399cf14971106f76e26463454ed3869a4b4dab5"
},
"downloads": -1,
"filename": "cdk-organizations-list-accounts-1.0.355.tar.gz",
"has_sig": false,
"md5_digest": "c511a3df330dd4982b622d95a620b630",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 30155,
"upload_time": "2023-03-20T01:10:02",
"upload_time_iso_8601": "2023-03-20T01:10:02.117894Z",
"url": "https://files.pythonhosted.org/packages/f6/82/a3790e4798ad9bbe5ca101e3a536228803b7b60015ca0e1c2f683f3a7b8b/cdk-organizations-list-accounts-1.0.355.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-20 01:10:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "hayao-k",
"github_project": "cdk-organizations-list-accounts.git",
"lcname": "cdk-organizations-list-accounts"
}