hashicorp / terraform-plugin-framework-validators

Common Use Case Validators for terraform-plugin-framework
Mozilla Public License 2.0
25 stars 12 forks source link

PkgGoDev

Terraform Plugin Framework Validators

terraform-plugin-framework-validators is a Go module containing common use case validators for terraform-plugin-framework types. It aims to provide generic type validator functionality that should be applicable to the broader framework-based provider ecosystem.

This Go module is not intended to define all possible validations. In particular, many validators that relate to specific string formats, encodings, and other specifics should instead be implemented separately in custom attribute types (e.g. a type implementing the attr.TypeWithValidators interface). Many of these custom types can be discovered by a conventional repository naming prefix of terraform-plugin-framework-. HashiCorp-supported custom types available for specific use cases include but are not limited to:

Terraform Plugin Framework Compatibility

This Go module is typically kept up to date with the latest terraform-plugin-framework releases to ensure all validator functionality is available.

Go Compatibility

This Go module follows terraform-plugin-framework Go compatibility.

Currently that means Go 1.22 must be used when developing and testing code.

Contributing

See .github/CONTRIBUTING.md

License

Mozilla Public License v2.0