# RDKlib
[](https://github.com/awslabs/aws-config-rdklib/actions?query=workflow%3Aci+branch%3Amaster)
RDKlib is a Python library to enable you to **run custom AWS Config
Rules at scale**. The library can be used to:
- Help you to focus only on the compliance logic, while the library
does the heavy lifting
- Ease maintenance by moving the boilerplate code as a AWS Lambda
Layer
- Ease deployment by using AWS Serverless Application Repository
RDKLib works in synergy with the [AWS Config Rule Development Kit](https://github.com/awslabs/aws-config-rdk).
# Getting Started
## Install the library locally
```bash
pip install rdklib
```
## Create a rule using the RDK
The runtime of your RDK rule have to be set to python3.11-lib in the RDK
to provide you the Rule template.
- For periodic trigger:
```bash
rdk create YOUR_RULE_NAME --runtime python3.11-lib --maximum-frequency TwentyFour_Hours
```
- For configuration change trigger (for example S3 Bucket):
```bash
rdk create YOUR_RULE_NAME --runtime python3.11-lib --resource-types AWS::S3::Bucket
```
> Note: you need to [install the RDK](https://github.com/awslabs/aws-config-rdk#getting-started) first.
## Deploy your rule with RDKlib layer
RDKLib is designed to work as a AWS Lambda Layer. It allows you to use the library without needing to include it in your deployment package.
1. Install RDKlib layer (with AWS CLI)
```bash
aws serverlessrepo create-cloud-formation-change-set --application-id arn:aws:serverlessrepo:ap-southeast-1:711761543063:applications/rdklib --stack-name RDKlib-Layer
# Copy/paste the full change-set ARN to customize the following command
aws cloudformation execute-change-set --change-set-name NAME_OF_THE_CHANGE_SET
aws cloudformation describe-stack-resources --stack-name serverlessrepo-RDKlib-Layer
# Copy the ARN of the Lambda layer in the "PhysicalResourceId" key (i.e. arn:aws:lambda:YOUR_REGION:YOUR_ACCOUNT:layer:rdklib-layer:1).
```
> Note: You can do the same step manually going to <https://console.aws.amazon.com/lambda/home#/create/function?tab=serverlessApps> and find "rdklib"
1. Deploy the rule
```bash
rdk deploy YOUR_RULE_NAME --rdklib-layer-arn YOUR_RDKLIB_LAYER_ARN
```
# License
This project is licensed under the Apache-2.0 License.
# Feedback / Questions
Feel free to email <rdk-maintainers@amazon.com>
# Contacts
- **Benjamin Morris** - _Maintainer, code, testing_
- **Carlo DePaolis** - _Maintainer, code, testing_
# Acknowledgements
- **Mark Beacom** - _Maintainer, code, testing_
- **Michael Borchert** - _Design, code, testing, feedback_
- **Ricky Chau** - _Maintainer, code, testing_
- **Julio Delgado Jr.** - *Design, testing, feedback*
- **Chris Gutierrez** - _Design, feedback_
- **Joe Lee** - _Design, feedback_
- **Jonathan Rault** - _Maintainer, design, code, testing, feedback_
Raw data
{
"_id": null,
"home_page": "https://github.com/awslabs/aws-config-rdklib",
"name": "rdklib",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.2,<4.0.0",
"maintainer_email": "",
"keywords": "amazon,aws,awslabs,rdk,rdklib,layer,lambda,config,rules,compliance",
"author": "AWS RDK Maintainers",
"author_email": "rdk-maintainers@amazon.com",
"download_url": "https://files.pythonhosted.org/packages/15/e5/e101b7cedcbce78d1482262c8cea2eac5ddf4927d894e0a5c12bcadd954c/rdklib-0.3.6.tar.gz",
"platform": null,
"description": "# RDKlib\n\n[](https://github.com/awslabs/aws-config-rdklib/actions?query=workflow%3Aci+branch%3Amaster)\n\nRDKlib is a Python library to enable you to **run custom AWS Config\nRules at scale**. The library can be used to:\n\n- Help you to focus only on the compliance logic, while the library\n does the heavy lifting\n- Ease maintenance by moving the boilerplate code as a AWS Lambda\n Layer\n- Ease deployment by using AWS Serverless Application Repository\n\nRDKLib works in synergy with the [AWS Config Rule Development Kit](https://github.com/awslabs/aws-config-rdk).\n\n# Getting Started\n\n## Install the library locally\n\n```bash\npip install rdklib\n```\n\n## Create a rule using the RDK\n\nThe runtime of your RDK rule have to be set to python3.11-lib in the RDK\nto provide you the Rule template.\n\n- For periodic trigger:\n\n```bash\n rdk create YOUR_RULE_NAME --runtime python3.11-lib --maximum-frequency TwentyFour_Hours\n```\n\n- For configuration change trigger (for example S3 Bucket):\n\n```bash\n rdk create YOUR_RULE_NAME --runtime python3.11-lib --resource-types AWS::S3::Bucket\n```\n\n> Note: you need to [install the RDK](https://github.com/awslabs/aws-config-rdk#getting-started) first.\n\n## Deploy your rule with RDKlib layer\n\nRDKLib is designed to work as a AWS Lambda Layer. It allows you to use the library without needing to include it in your deployment package.\n\n1. Install RDKlib layer (with AWS CLI)\n\n```bash\n aws serverlessrepo create-cloud-formation-change-set --application-id arn:aws:serverlessrepo:ap-southeast-1:711761543063:applications/rdklib --stack-name RDKlib-Layer\n\n # Copy/paste the full change-set ARN to customize the following command\n aws cloudformation execute-change-set --change-set-name NAME_OF_THE_CHANGE_SET\n\n aws cloudformation describe-stack-resources --stack-name serverlessrepo-RDKlib-Layer\n # Copy the ARN of the Lambda layer in the \"PhysicalResourceId\" key (i.e. arn:aws:lambda:YOUR_REGION:YOUR_ACCOUNT:layer:rdklib-layer:1).\n```\n\n> Note: You can do the same step manually going to <https://console.aws.amazon.com/lambda/home#/create/function?tab=serverlessApps> and find \"rdklib\"\n\n1. Deploy the rule\n\n```bash\n rdk deploy YOUR_RULE_NAME --rdklib-layer-arn YOUR_RDKLIB_LAYER_ARN\n```\n\n# License\n\nThis project is licensed under the Apache-2.0 License.\n\n# Feedback / Questions\n\nFeel free to email <rdk-maintainers@amazon.com>\n\n# Contacts\n\n- **Benjamin Morris** - _Maintainer, code, testing_\n- **Carlo DePaolis** - _Maintainer, code, testing_\n\n# Acknowledgements\n\n- **Mark Beacom** - _Maintainer, code, testing_\n- **Michael Borchert** - _Design, code, testing, feedback_\n- **Ricky Chau** - _Maintainer, code, testing_\n- **Julio Delgado Jr.** - *Design, testing, feedback*\n- **Chris Gutierrez** - _Design, feedback_\n- **Joe Lee** - _Design, feedback_\n- **Jonathan Rault** - _Maintainer, design, code, testing, feedback_\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Rule Development Kit Library for AWS Config",
"version": "0.3.6",
"project_urls": {
"Documentation": "https://aws-config-rdklib.readthedocs.io",
"Homepage": "https://github.com/awslabs/aws-config-rdklib",
"Repository": "https://github.com/awslabs/aws-config-rdklib"
},
"split_keywords": [
"amazon",
"aws",
"awslabs",
"rdk",
"rdklib",
"layer",
"lambda",
"config",
"rules",
"compliance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0acce6eb9cba54463635362838e0315b1ec3c6e4bc2f36275ef85a9c54facc54",
"md5": "d64d2fee76feb1e5ee72b5b2a9d9fb69",
"sha256": "64e259c5d2142d950fd62e17fb62116f047277eff357a52736df68006b9a5e36"
},
"downloads": -1,
"filename": "rdklib-0.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d64d2fee76feb1e5ee72b5b2a9d9fb69",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.2,<4.0.0",
"size": 24139,
"upload_time": "2024-01-18T21:05:49",
"upload_time_iso_8601": "2024-01-18T21:05:49.091723Z",
"url": "https://files.pythonhosted.org/packages/0a/cc/e6eb9cba54463635362838e0315b1ec3c6e4bc2f36275ef85a9c54facc54/rdklib-0.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15e5e101b7cedcbce78d1482262c8cea2eac5ddf4927d894e0a5c12bcadd954c",
"md5": "410887b5da94c2969470d207a7bf195d",
"sha256": "8b5cc880eccb455c71e859e1016c5506849e41cd8ba48bba5c30679edd521f87"
},
"downloads": -1,
"filename": "rdklib-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "410887b5da94c2969470d207a7bf195d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.2,<4.0.0",
"size": 14545,
"upload_time": "2024-01-18T21:05:50",
"upload_time_iso_8601": "2024-01-18T21:05:50.774904Z",
"url": "https://files.pythonhosted.org/packages/15/e5/e101b7cedcbce78d1482262c8cea2eac5ddf4927d894e0a5c12bcadd954c/rdklib-0.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 21:05:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "awslabs",
"github_project": "aws-config-rdklib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rdklib"
}
JSON
