IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2024-12-26 00:41:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Rename page again

Browse Source
This commit is contained in:
Laura Pacilio 2022-03-30 17:18:16 -04:00
parent 42d73fe324
commit 5effda4170
3 changed files with 5 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/data/language-nav-data.json
View File

@ -280,8 +280,8 @@
"path": "expressions/version-constraints"
},
{
"title": "Custom Data Validation",
"path": "expressions/custom-data-validation"
"title": "Custom Validation Rules",
"path": "expressions/custom-validation-rules"
}
]
},

0
website/docs/language/expressions/custom-data-validation.mdx → website/docs/language/expressions/custom-validation-rules.mdx
View File

37
website/docs/language/values/variables.mdx
View File

@ -160,9 +160,7 @@ commentary for module maintainers, use comments.
-> This feature was introduced in Terraform CLI v0.13.0.
In addition to Type Constraints as described above, a module author can specify
arbitrary custom validation rules for a particular variable using a `validation`
block nested within the corresponding `variable` block:
In addition to Type Constraints, you can specify custom validation rules for a particular variable using a `validation` block nested within the corresponding `variable` block. The example below checks whether the AMI ID has the correct syntax.
```hcl
variable "image_id" {
@ -175,38 +173,7 @@ variable "image_id" {
}
}
```
The `condition` argument is an expression that must use the value of the
variable to return `true` if the value is valid, or `false` if it is invalid.
The expression can refer only to the variable that the condition applies to,
and _must not_ produce errors.
If the failure of an expression is the basis of the validation decision, use
[the `can` function](/language/functions/can) to detect such errors. For example:
```hcl
variable "image_id" {
type = string
description = "The id of the machine image (AMI) to use for the server."
validation {
# regex(...) fails if it cannot find a match
condition = can(regex("^ami-", var.image_id))
error_message = "The image_id value must be a valid AMI id, starting with \"ami-\"."
}
}
```
If `condition` evaluates to `false`, Terraform will produce an error message
that includes the result of the `error_message` expression. The error message
should be at least one full sentence explaining the constraint that failed,
using a sentence structure similar to the above examples.
Error messages can be literal strings, heredocs, or template expressions. The
only valid reference in an error message is the variable under validation.
Multiple `validation` blocks can be declared in which case error messages
will be returned for _all_ failed conditions.
Refer to [Custom Data Validation](/language/expressions/custom-validation-rules) for more details.
### Suppressing Values in CLI Output