[User Guide] Module Variables

The module can be customised using the following input variables (click on each input name for more details):

Required Inputs

These variables must be set in the module block when using this module.

root_parent_id string

Description: The root_parent_id is used to specify where to set the root for all Landing Zone deployments. Usually the Tenant ID when deploying the core Enterprise-scale Landing Zones.

Optional Inputs

These variables have default values and don't have to be set to use this module. You may set these variables in the module block to override their default values.

archetype_config_overrides map(any)

Description: OPTIONAL: If specified, will set custom Archetype configurations to the default Enterprise-scale Management Groups.

Default: {}

custom_landing_zones map( object({ display_name = string parent_management_group_id = string subscription_ids = list(string) archetype_config = object({ archetype_id = string parameters = any access_control = any }) }) )

Description: OPTIONAL: If specified, will deploy additional Management Groups alongside Enterprise-scale core Management Groups.

Default: {}

default_location string

Description: OPTIONAL: If specified, will use set the default location used for resource deployments where needed.

Default: "eastus"

deploy_core_landing_zones bool

Description: OPTIONAL: If set to true, will include the core Enterprise-scale Management Group hierarchy.

Default: true

deploy_demo_landing_zones bool

Description: OPTIONAL: If set to true, will include the demo "Landing Zone" Management Groups.

Default: false

library_path string

Description: OPTIONAL: If specified, sets the path to a custom library folder for archetype artefacts.

Default: ""

root_id string

Description: OPTIONAL: If specified, will set a custom Name (ID) value for the Enterprise-scale "root" Management Group, and append this to the ID for all core Enterprise-scale Management Groups.

Default: "es"

root_name string

Description: OPTIONAL: If specified, will set a custom DisplayName value for the Enterprise-scale "root" Management Group.

Default: "Enterprise-Scale"

subscription_id_overrides map(list(string))

Description: OPTIONAL: If specified, will be used to assign subscription_ids to the default Enterprise-scale Management Groups.

Default: {}

template_file_variables map(any)

Description: OPTIONAL: If specified, provides the ability to define custom template variables used when reading in template files from the built-in and custom library_path.

Default: {}

A summary of these variables can also be found on the Inputs tab of the module entry in Terraform Registry.

Next steps

Now you understand how to customize your deployment using the input variables, check out our Examples.