fwxschema

Documentation

Overview

Package fwxschema implements extra framework-based schema functionality on top of base Terraform attribute functionality.

This package is separated from fwschema to prevent import cycles with existing tfsdk functionality.

Index

• type AttributeWithPlanModifiers
• type AttributeWithValidators
• type BlockWithPlanModifiers
• type BlockWithValidators

Types

type AttributeWithPlanModifiers

type AttributeWithPlanModifiers interface {
	// Implementations should include the fwschema.Attribute interface methods
	// for proper attribute handling.
	fwschema.Attribute

	// GetPlanModifiers should return a list of attribute-based plan modifiers.
	// This is named differently than PlanModifiers to prevent a conflict with
	// the tfsdk.Attribute field name.
	GetPlanModifiers() tfsdk.AttributePlanModifiers
}

AttributeWithPlanModifiers is an optional interface on Attribute which enables plan modification support.

type AttributeWithValidators

type AttributeWithValidators interface {
	// Implementations should include the fwschema.Attribute interface methods
	// for proper attribute handling.
	fwschema.Attribute

	// GetValidators should return a list of attribute-based validators. This
	// is named differently than PlanModifiers to prevent a conflict with the
	// tfsdk.Attribute field name.
	GetValidators() []tfsdk.AttributeValidator
}

AttributeWithValidators is an optional interface on Attribute which enables validation support.

type BlockWithPlanModifiers

type BlockWithPlanModifiers interface {
	// Implementations should include the fwschema.Block interface methods
	// for proper block handling.
	fwschema.Block

	// GetPlanModifiers should return a list of attribute-based plan modifiers.
	// This is named differently than PlanModifiers to prevent a conflict with
	// the tfsdk.Block field name.
	GetPlanModifiers() tfsdk.AttributePlanModifiers
}

BlockWithPlanModifiers is an optional interface on Block which enables plan modification support.

type BlockWithValidators

type BlockWithValidators interface {
	// Implementations should include the fwschema.Block interface methods
	// for proper block handling.
	fwschema.Block

	// GetValidators should return a list of attribute-based validators. This
	// is named differently than Validators to prevent a conflict with the
	// tfsdk.Block field name.
	GetValidators() []tfsdk.AttributeValidator
}

BlockWithValidators is an optional interface on Block which enables validation support.