Validate Configuration
Providers support validating an entire practitioner configuration in either declarative or imperative logic. Feedback, such as required syntax or acceptable combinations of values, is returned via diagnostics.
This page describes implementation details for validating entire provider configurations, typically referencing multiple attributes. Further documentation is available for other configuration validation concepts:
- Single attribute validation is a schema-based mechanism for implementing attribute-specific validation logic.
- Type validation is a schema-based mechanism for implementing reusable validation logic for any attribute using the type.
Configuration validation in Terraform occurs without provider configuration ("offline"), so therefore the provider Configure
method will not have been called. To implement validation with a configured API client, use logic within the Configure
method, which occurs during Terraform's planning phase.
ConfigValidators Method
The provider.ProviderWithConfigValidators
interface follows a similar pattern to attribute validation and allows for a more declarative approach. This enables consistent validation logic across multiple providers. Each validator intended for this interface must implement the provider.ConfigValidator
interface.
During execution of the terraform validate
, terraform plan
and terraform apply
commands, Terraform calls the provider ValidateProviderConfig
RPC, in which the framework calls the ConfigValidators
method on providers that implement the provider.ProviderWithConfigValidators
interface.
The terraform-plugin-framework-validators
Go module has a collection of common use case provider configuration validators in the providervalidator
package. These use path expressions for matching attributes.
This example will raise an error if a practitioner attempts to configure both attribute_one
and attribute_two
:
ValidateConfig Method
The provider.ProviderWithValidateConfig
interface is more imperative in design and is useful for validating unique functionality across multiple attributes that typically applies to a single provider.
During execution of the terraform validate
, terraform plan
and terraform apply
commands, Terraform calls the provider ValidateProviderConfig
RPC, in which the framework calls the ValidateConfig
method on providers that implement the provider.ProviderWithValidateConfig
interface.
This example will raise a warning if a practitioner attempts to configure attribute_one
, but not attribute_two
: