Terraform policy reference overview

This section provides detailed reference documentation for Terraform policy, including CLI commands, policy configuration syntax, functions, and test configuration syntax.

CLI Reference

The Terraform policy CLI (tfpolicy) provides commands for validating and testing your policies locally.

• CLI overview: Global flags and command overview
• tfpolicy test: Run policy tests
• tfpolicy validate: Validate policy syntax
• tfpolicy version: Display version information

Policy configuration reference

Reference documentation for policy file syntax and configuration blocks.

• Policy configuration overview - Overview of policy file syntax
• The policy block - Configure Terraform Policy
• The provider_policy block - Write provider policies
• The resource_policy block - Write resource policies
• The module_policy block - Write module policies
• The input block - Define input variables
• The locals block - Define local values

Test configuration reference

Reference documentation for policy test file syntax and configuration blocks.

• Test configuration overview - Overview of test file syntax
• The policytest block - Configure test targets
• Mock provider blocks - Define mock providers
• Mock resource blocks - Define mock resources
• Mock data source blocks - Define mock data sources
• Mock module blocks - Define mock modules
• The inputs block - Set input values for tests
• The locals block - Define local values for tests

Operators reference

Reference documentation for the operators available in policy and test files

• Operators: Arithmetic, comparison, and logical operators

Functions reference

Reference documentation for built-in and plugin functions.

• Functions overview: Overview of available functions
• core::getresources: Fetch resources
• core::getdatasource: Fetch data sources
• core::gethttprequest: Make HTTP requests
• core::semverconstraint: Validate semantic versions