Validate, get validation patterns and generate valid AWS resource names (for testing \ mocks)
Project description
AWS Resource Validator
aws_resource_validator
is a Python package that creates objects to validate, show constraints of common AWS resource names, and generate compatible patterns for tests. This helps ensure that AWS resource names comply with AWS naming rules and can be used for testing and validation purposes.
📜Documentation | Blogs website
Features
- Validation: Check if a given AWS resource name meets the AWS naming constraints.
- Constraint Display: Display constraints for different AWS resource names.
- Pattern Generation: Generate compatible patterns for AWS resource names for testing purposes.
Installation
You can install the package via pip:
pip install aws_resource_validator
Usage Example
Here's a simple example demonstrating how to use aws_resource_validator
:
from aws_resource_validator.class_definitions import Acm, class_registry
# Use type hint so that you can use `api_registry` with full class definitions
acm: Acm = class_registry.Acm
print(acm.Arn.pattern)
print(acm.Arn.type)
print(acm.Arn.validate("example-arn"))
print(acm.Arn.generate())
Contributing
We welcome contributions from everyone. Please see our CONTRIBUTING.md for more details.
Security
For information on reporting security vulnerabilities, please see our SECURITY.md.
Code of Conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contact
If you have any questions, feel free to reach out to us:
- Alexy Grabov: alexy.grabov@gmail.com
- Yafit Tupman: ytupman@gmail.com
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file aws_resource_validator-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: aws_resource_validator-0.2.0-py3-none-any.whl
- Upload date:
- Size: 2.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.19
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc9a0700663c97b61443e8dd0f9044c210e23146f7ecfdf3dd4740d75858dbf7 |
|
MD5 | 90e358e12c7fab05b06ad7650a0e9f46 |
|
BLAKE2b-256 | 7d512ef8dbafb994724d411662e47fb57e82ba7ede0adeefa3db554c2ae2e24c |