README
¶
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-type-.
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.18 must be used when developing and testing code.
Contributing
License
Directories
¶
| Path | Synopsis |
|---|---|
|
Package boolvalidator provides validators for types.Bool attributes.
|
Package boolvalidator provides validators for types.Bool attributes. |
|
Package datasourcevalidator provides validators to express relationships between multiple attributes of a data source.
|
Package datasourcevalidator provides validators to express relationships between multiple attributes of a data source. |
|
Package float64validator provides validators for types.Float64 attributes.
|
Package float64validator provides validators for types.Float64 attributes. |
|
helpers
|
|
|
validatordiag
Package validatordiag provides diagnostics helpers for validator implementations.
|
Package validatordiag provides diagnostics helpers for validator implementations. |
|
Package int64validator provides validators for types.Int64 attributes.
|
Package int64validator provides validators for types.Int64 attributes. |
|
internal
|
|
|
configvalidator
Package configvalidator provides the generic configuration validator implementations for the exported datasourcevalidator, providervalidator, and resourcevalidator packages.
|
Package configvalidator provides the generic configuration validator implementations for the exported datasourcevalidator, providervalidator, and resourcevalidator packages. |
|
schemavalidator
Package schemavalidator provides validators to express relationships between multiple attributes within the schema of a resource, data source, or provider.
|
Package schemavalidator provides validators to express relationships between multiple attributes within the schema of a resource, data source, or provider. |
|
Package listvalidator provides validators for types.List attributes.
|
Package listvalidator provides validators for types.List attributes. |
|
Package mapvalidator provides validators for types.Map attributes.
|
Package mapvalidator provides validators for types.Map attributes. |
|
Package numbervalidator provides validators for types.Number attributes.
|
Package numbervalidator provides validators for types.Number attributes. |
|
Package objectvalidator provides validators for types.Object attributes.
|
Package objectvalidator provides validators for types.Object attributes. |
|
Package providervalidator provides validators to express relationships between multiple attributes of a provider.
|
Package providervalidator provides validators to express relationships between multiple attributes of a provider. |
|
Package resourcevalidator provides validators to express relationships between multiple attributes of a resource.
|
Package resourcevalidator provides validators to express relationships between multiple attributes of a resource. |
|
Package setvalidator provides validators for types.Set attributes.
|
Package setvalidator provides validators for types.Set attributes. |
|
Package stringvalidator provides validators for types.String attributes.
|
Package stringvalidator provides validators for types.String attributes. |