resourcevalidator

Documentation

Overview

Package resourcevalidator provides validators to express relationships between multiple attributes of a resource. For example, checking that multiple attributes are not configured at the same time.

These validators are implemented outside the schema, which may be easier to implement in provider code generation situations or suit provider code preferences differently than those in the schemavalidator package. Those validators start on a starting attribute, where relationships can be expressed as absolute paths to others or relative to the starting attribute.

Index

• func AtLeastOneOf(expressions ...path.Expression) resource.ConfigValidator
• func Conflicting(expressions ...path.Expression) resource.ConfigValidator
• func ExactlyOneOf(expressions ...path.Expression) resource.ConfigValidator
• func RequiredTogether(expressions ...path.Expression) resource.ConfigValidator

Examples

• AtLeastOneOf
• Conflicting
• ExactlyOneOf
• RequiredTogether

Functions

func AtLeastOneOf

func AtLeastOneOf(expressions ...path.Expression) resource.ConfigValidator

AtLeastOneOf checks that a set of path.Expression has at least one non-null or unknown value.

Example

package main

import (
	"github.com/hashicorp/terraform-plugin-framework-validators/resourcevalidator"
	"github.com/hashicorp/terraform-plugin-framework/path"
	"github.com/hashicorp/terraform-plugin-framework/resource"
)

func main() {
	// Used inside a resource.Resource type ConfigValidators method
	_ = []resource.ConfigValidator{
		// Validate at least one of the schema defined attributes named attr1
		// and attr2 has a known, non-null value.
		resourcevalidator.AtLeastOneOf(
			path.MatchRoot("attr1"),
			path.MatchRoot("attr2"),
		),
	}
}

func Conflicting

func Conflicting(expressions ...path.Expression) resource.ConfigValidator

Conflicting checks that a set of path.Expression, are not configured simultaneously.

Example

package main

import (
	"github.com/hashicorp/terraform-plugin-framework-validators/resourcevalidator"
	"github.com/hashicorp/terraform-plugin-framework/path"
	"github.com/hashicorp/terraform-plugin-framework/resource"
)

func main() {
	// Used inside a resource.Resource type ConfigValidators method
	_ = []resource.ConfigValidator{
		// Validate that schema defined attributes named attr1 and attr2 are not
		// both configured with known, non-null values.
		resourcevalidator.Conflicting(
			path.MatchRoot("attr1"),
			path.MatchRoot("attr2"),
		),
	}
}

func ExactlyOneOf

func ExactlyOneOf(expressions ...path.Expression) resource.ConfigValidator

ExactlyOneOf checks that a set of path.Expression does not have more than one known value.

Example

package main

import (
	"github.com/hashicorp/terraform-plugin-framework-validators/resourcevalidator"
	"github.com/hashicorp/terraform-plugin-framework/path"
	"github.com/hashicorp/terraform-plugin-framework/resource"
)

func main() {
	// Used inside a resource.Resource type ConfigValidators method
	_ = []resource.ConfigValidator{
		// Validate only one of the schema defined attributes named attr1
		// and attr2 has a known, non-null value.
		resourcevalidator.ExactlyOneOf(
			path.MatchRoot("attr1"),
			path.MatchRoot("attr2"),
		),
	}
}

func RequiredTogether

func RequiredTogether(expressions ...path.Expression) resource.ConfigValidator

RequiredTogether checks that a set of path.Expression either has all known or all null values.

Example

package main

import (
	"github.com/hashicorp/terraform-plugin-framework-validators/resourcevalidator"
	"github.com/hashicorp/terraform-plugin-framework/path"
	"github.com/hashicorp/terraform-plugin-framework/resource"
)

func main() {
	// Used inside a resource.Resource type ConfigValidators method
	_ = []resource.ConfigValidator{
		// Validate the schema defined attributes named attr1 and attr2 are either
		// both null or both known values.
		resourcevalidator.RequiredTogether(
			path.MatchRoot("attr1"),
			path.MatchRoot("attr2"),
		),
	}
}