packer-cn/website/content/docs/from-1.5/blocks/variable.mdx

41 lines
1.1 KiB
Plaintext
Raw Normal View History

2020-05-26 09:29:47 -04:00
---
description: >
The variable block, also called the input-variable block, defines variables
2020-05-28 11:04:34 -04:00
within your Packer configuration.
2020-05-26 09:29:47 -04:00
page_title: variable - Blocks
sidebar_title: <tt>variable</tt>
---
# The `variable` block
`@include 'from-1.5/beta-hcl2-note.mdx'`
The `variable` block, also called the `input-variable` block, defines variables
2020-05-26 09:29:47 -04:00
within your Packer configuration. An input-variable cannot be used in another
input variable: we recommend using [locals](/docs/from-1.5/blocks/locals) for that instead.
2020-05-26 09:29:47 -04:00
`@include 'from-1.5/variables/foo-block.mdx'`
## Default value
If a default value is set, the variable is optional. Otherwise, the variable
**must** be set.
`@include 'from-1.5/variables/assignment.mdx'`
2020-11-02 11:20:46 -05:00
`@include 'from-1.5/variables/custom-validation.mdx'`
2020-05-26 09:29:47 -04:00
Example of a variable assignment from a file:
`@include 'from-1.5/variables/foo-pkrvar.mdx'`
`@include 'from-1.5/variables/must-be-set.mdx'`
2020-10-05 09:27:12 -04:00
`@include 'from-1.5/variables/sensitive.mdx'`
2020-05-26 09:29:47 -04:00
# More on variables
- Read the [full variables](/docs/from-1.5/variables) description for a more
thorough read.
- Read the [variables guide](/guides/hcl/variables) for more examples.