Optional attributes in objects in Terraform - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does it mean when an attribute in a Terraform object type is optional?

An optional attribute means you do not have to provide a value for it when defining the object. Terraform will accept the object without that attribute.

beginner

How do you declare an optional attribute in a Terraform object type?

Use the syntax optional(type) for the attribute's type inside the object definition. For example: optional(string).

intermediate

What happens if you omit an optional attribute in a Terraform object when applying a configuration?

Terraform uses the default value if provided, or treats the attribute as absent without error if no default is set.

intermediate

Can optional attributes in Terraform objects have default values?

Yes, optional attributes can have default values defined in the variable declaration, which Terraform uses if the attribute is not set.

beginner

Give an example of a Terraform object type with one required and one optional attribute.

Example: object({ name = string, age = optional(number) }) Here, name is required and age is optional.

How do you mark an attribute as optional in a Terraform object type?

A Use <code>nullable(type)</code>

B Use <code>optional(type)</code>

C Use <code>required(type)</code>

D Use <code>default(type)</code>

In Terraform, optional attributes are declared with optional(type) inside the object type.

What happens if you omit an optional attribute in a Terraform object without a default value?

A Terraform throws an error

B Terraform requires you to set a value

C Terraform assigns a null value automatically

D Terraform treats the attribute as absent

Terraform treats omitted optional attributes without defaults as absent and does not throw an error.

Which of these is a valid Terraform object type with an optional attribute?

A object({ id = string, description = optional(string) })

B object({ id = optional(string), description = string })

C object({ id = required(string), description = string })

D object({ id = nullable(string), description = optional(string) })

Option A correctly uses optional(string) to mark 'description' as optional.

Can optional attributes in Terraform objects have default values?

A No, optional attributes cannot have defaults

B Only required attributes can have defaults

C Yes, they can have default values

D Defaults are not supported in Terraform

Optional attributes can have default values which Terraform uses if the attribute is not provided.

If an attribute is not marked optional in a Terraform object type, what does that mean?

A The attribute is required

B The attribute is optional

C The attribute is ignored

D The attribute has a default value

Attributes not marked optional are required and must be provided.

Explain how to define an optional attribute in a Terraform object type and what happens if it is omitted.

Think about how Terraform handles missing values in objects.

Describe a practical example where optional attributes in Terraform objects are useful.

Consider a resource that sometimes needs extra info but not always.

Practice

1. What does the optional(type, default) function do in a Terraform object type?

easy

A. It allows an attribute to be skipped and provides a default value if missing.

B. It makes an attribute required and enforces a value.

C. It deletes the attribute from the object.

D. It converts the attribute to a list type.

Solution

1. Step 1: Understand optional attribute purpose

   Optional attributes let you omit some fields safely without errors.

2. Step 2: Role of default value

   The default value is used when the attribute is not provided, ensuring smooth operation.

3. Final Answer:

   It allows an attribute to be skipped and provides a default value if missing. -> Option A

4. Quick Check:

   optional(type, default) = skip with default [OK]

Hint: Optional means skip allowed with default value [OK]

Common Mistakes:

• Thinking optional means required
• Assuming it deletes attributes
• Confusing optional with type conversion

2. Which of the following is the correct syntax to define an optional string attribute named region with default "us-west-1" in a Terraform object type?

easy

A. object({ optional(region, string, "us-west-1") })

B. object({ region = optional(string, "us-west-1") })

C. object({ region = string.optional("us-west-1") })

D. object({ region: optional(string, "us-west-1") })

Solution

1. Step 1: Recall correct optional attribute syntax

   The correct syntax is attribute = optional(type, default) inside object.

2. Step 2: Match syntax with options

   object({ region = optional(string, "us-west-1") }) matches this pattern exactly with attribute name and default value.

3. Final Answer:

   object({ region = optional(string, "us-west-1") }) -> Option B

4. Quick Check:

   Correct optional attribute syntax = object({ region = optional(string, "us-west-1") }) [OK]

Hint: Use attribute = optional(type, default) inside object [OK]

Common Mistakes:

• Placing optional outside attribute name
• Using colon instead of equals
• Wrong order of parameters

3. Given this Terraform variable type declaration:

variable "config" {
  type = object({
    name = string
    description = optional(string, "No description")
  })
}

What will be the value of var.config.description if the input is { name = "App" }?

medium

A. "No description"

B. null

C. Error: missing required attribute

D. "App"

Solution

1. Step 1: Identify optional attribute with default

   The description attribute is optional with default "No description".

2. Step 2: Check input for description

   The input does not provide description, so default applies.

3. Final Answer:

   "No description" -> Option A

4. Quick Check:

   Missing optional attribute uses default [OK]

Hint: Missing optional attribute uses default value [OK]

Common Mistakes:

• Expecting null instead of default
• Thinking missing optional causes error
• Confusing attribute values

4. You wrote this object type in Terraform:

object({
  id = string
  tags = optional(map(string))
})

But when you apply, Terraform shows an error about tags. What is the likely cause?

medium

A. Optional attributes cannot be maps

B. Missing default value for optional attribute tags

C. Syntax error: missing comma after id

D. The attribute id should be optional

Solution

1. Step 1: Check object type syntax

   In Terraform object types, attributes must be separated by commas.

2. Step 2: Identify missing comma

   After id = string there is no comma before tags, causing a syntax error often reported at tags.

3. Final Answer:

   Syntax error: missing comma after id -> Option C

4. Quick Check:

   Missing comma in object type causes syntax error [OK]

Hint: Object attributes need commas between them [OK]

Common Mistakes:

• Forgetting commas between attributes
• Thinking optional(map) requires explicit default
• Assuming maps can't be optional

5. You want to define a Terraform object type for a server configuration with these rules:
- hostname is required string
- port is optional number, default 80
- tags is optional map of strings, default empty map

Which of these is the correct type declaration?

hard

A. object({ hostname = string, port = optional(number), tags = map(string) })

B. object({ hostname = optional(string), port = number, tags = optional(map(string)) })

C. object({ hostname = string, port = number, tags = optional(map(string), null) })

D. object({ hostname = string, port = optional(number, 80), tags = optional(map(string), {}) })

Solution

1. Step 1: Identify required and optional attributes

   hostname is required string, port optional number with default 80, tags optional map with default empty map.

2. Step 2: Match syntax with rules

   object({ hostname = string, port = optional(number, 80), tags = optional(map(string), {}) }) correctly uses optional(type, default) for port and tags, and required string for hostname.

3. Final Answer:

   object({ hostname = string, port = optional(number, 80), tags = optional(map(string), {}) }) -> Option D

4. Quick Check:

   Required and optional with defaults correctly declared [OK]

Hint: Use optional(type, default) for optional with defaults [OK]

Common Mistakes:

• Missing default for optional attributes
• Marking required attributes as optional
• Using null instead of empty map as default