Local Variables

Updated on 2023-08-11 GMT+08:00

View PDF

Local values are like temporary variables in a module. Their application scope is in the declared module. They are declared by the keyword locals. Local variables can be helpful to reduce code redundancy and make code easy to modify in scenarios where the same values or expressions are repeatedly defined in the configuration. However, if local variables are overused, the actual values are hidden, making code hard to read by future maintainers. Therefore, use local variables properly.

Declaring Local Variables

Local variables are declared using the keyword locals.

locals {
  service_name = "forum"
  owner        = "Community"
}

Expressions of local variables are not limited to character and numeric constants. They can also use references and expression results of input variables, resource attributes, or other local values.

locals {
}

locals {
  common_tags = {
    Service = local.service_name
    Owner   = local.owner
  }
}

Referencing Local Variables

After declaring a local variable, you can use local.<Variable name> to reference it.

  ...
  tags = local.common_tags
}

Parent topic: Variables

Previous topic: Output Variables

Next topic: Metadata

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel