Skip to main content

Validate, get validation patterns and generate valid AWS resource names (for testing \ mocks)

Project description

AWS Resource Validator

version PythonSupport GitHub License] github-star-badge issues

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:

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

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

aws_resource_validator-0.2.1-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

Details for the file aws_resource_validator-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_resource_validator-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 52c367abcf0349bf5ef060f0146e68bc6e051715260855e043eb2c6704355539
MD5 7cdbfe1e08a2b6c69852a77bfb05e3e1
BLAKE2b-256 b2caeb129499935c1a1894c114cacba7fe1e35f1bf12a00aee64b2bad1a50b95

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page