Terraform Mastery – Day 10: Functions in Terraform

Introduction

Functions in Terraform enhance configurations by enabling dynamic values, data manipulation, and logical operations. They improve reusability, reduce redundancy, and help create more flexible infrastructure-as-code (IaC). Terraform provides built-in functions categorized into string, numeric, collection, encoding, filesystem, and date/time functions.

This guide explores essential Terraform functions, their usage, and examples to improve your IaC skills.

---

1. Types of Functions in Terraform

Terraform offers various built-in functions categorized as follows:

a) String Functions

String functions manipulate and transform text-based values.

🔹 Common String Functions:

• lower(string) → Converts text to lowercase.

• upper(string) → Converts text to uppercase.

• length(string) → Returns the length of a string.

• replace(string, old, new) → Replaces occurrences of old with new.

• trimspace(string) → Removes leading and trailing spaces.

Example:

variable "name" {
  default = "Terraform"
}

output "lowercase_name" {
  value = lower(var.name) // Output: terraform
}

---

b) Numeric Functions

Numeric functions help perform mathematical operations on numbers.

🔹 Common Numeric Functions:

• min(a, b, ...) → Returns the smallest number.

• max(a, b, ...) → Returns the largest number.

• abs(number) → Returns the absolute value of a number.

• ceil(number) → Rounds up to the nearest integer.

• floor(number) → Rounds down to the nearest integer.

Example:

output "min_value" {
  value = min(10, 5, 20) // Output: 5
}

---

c) Collection Functions

Collection functions work with lists, maps, and sets.

🔹 Common Collection Functions:

• length(collection) → Returns the number of elements.

• contains(collection, value) → Checks if a value exists in a list.

• join(separator, list) → Joins elements with a separator.

• split(separator, string) → Splits a string into a list.

• flatten(list_of_lists) → Flattens a nested list.

Example:

variable "my_list" {
  default = ["AWS", "Azure", "GCP"]
}

output "joined_clouds" {
  value = join(", ", var.my_list) // Output: AWS, Azure, GCP
}

---

d) Encoding Functions

These functions handle data conversions such as JSON encoding.

🔹 Common Encoding Functions:

• jsonencode(value) → Converts a Terraform value to JSON format.

• jsondecode(json_string) → Converts JSON into a Terraform object.

• base64encode(string) → Encodes a string in Base64.

• base64decode(string) → Decodes a Base64-encoded string.

Example:

variable "my_map" {
  default = {
    name  = "Pritish"
    role  = "DevOps Engineer"
  }
}

output "json_output" {
  value = jsonencode(var.my_map)
}

Output:

{"name":"Pritish","role":"DevOps Engineer"}

---

e) Filesystem Functions

These functions handle file-based operations in Terraform.

🔹 Common Filesystem Functions:

• file(path) → Reads the content of a file.

• templatefile(path, vars) → Loads a file and replaces placeholders with provided values.

Example:

output "read_file" {
  value = file("example.txt")
}

---

f) Date and Time Functions

Terraform provides date/time functions for timestamp manipulation.

🔹 Common Date Functions:

• timestamp() → Returns the current timestamp in UTC.

• formatdate(format, timestamp) → Formats a timestamp.

• timeadd(timestamp, duration) → Adds time to a timestamp.

Example:

output "current_time" {
  value = timestamp()
}

---

2. Combining Functions in Terraform

You can combine multiple functions to perform advanced operations.

Example: Using join(), upper(), and replace() together

variable "clouds" {
  default = ["aws", "azure", "gcp"]
}

output "modified_clouds" {
  value = replace(upper(join(", ", var.clouds)), "AWS", "Amazon Web Services")
}

Output:

Amazon Web Services, AZURE, GCP

---

3. Using Functions in Terraform Modules

Functions are commonly used in Terraform modules to enhance reusability.

Example: Using jsonencode() in a module

module "instance" {
  source = "./ec2_module"

  config = jsonencode({
    instance_type = "t3.micro"
    region        = "us-east-1"
  })
}

---

Conclusion

Terraform functions are essential for creating dynamic, scalable, and efficient infrastructure. They allow you to manipulate data, perform calculations, and optimize configurations effortlessly.

By mastering Terraform functions, you can enhance automation, improve code maintainability, and build powerful cloud environments. 🚀

🔹 Next Topic: Files in Terraform – Stay tuned for more!