Skip to content

webapps/static_site

Overview

This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.

Dependency diagram (Mermaid)

graph TD azurecaf_name.static_site["azurecaf_name.static_site"] azurerm_static_web_app.static_site["azurerm_static_web_app.static_site"] azurerm_static_web_app_custom_domain.custom_domains["azurerm_static_web_app_custom_domain.custom_domains"] module.diagnostics["module.diagnostics"] azurerm_static_web_app.static_site --> azurecaf_name.static_site azurerm_static_web_app_custom_domain.custom_domains --> azurerm_static_web_app.static_site module.diagnostics --> azurerm_static_web_app.static_site

Module Reference

Category: webapps
Path: modules/webapps/static_site
Azure Resources: azurecaf_name, azurerm_static_web_app, azurerm_static_web_app_custom_domain

Inputs

Name Description Type Required Default Validation
client_config Client configuration object (see module README.md). any yes - -
tags (Required) map of tags for the deployment map(any) yes - -
name (Required) Name of the Static Site string yes - -
location (Required) Resource Location string yes - -
resource_group_name (Required) Resource group of the Static Site string yes - -
sku_tier Specifies the SKU tier of the Static Web App. Possible values are Free or Standard. Defaults to Free. string no - Allowed values are Free or Standard.
sku_size Specifies the SKU size of the Static Web App. Possible values are Free or Standard. Defaults to Free. string no - Allowed values are Free or Standard.
identity any no - -
global_settings Global settings object (see module README.md) any yes - -
base_tags Base tags for the resource to be inherited from the resource group. map(any) yes - -
diagnostic_profiles map(any) no {} -
diagnostics any no - -
custom_domains map(any) no {} -
remote_objects Remote objects configuration. any yes - -
settings The settings for the Azure resource. any yes - -

Outputs

Name Description Sensitive Value
id The ID of the Static Site. - azurerm_static_web_app.static_site.id
default_host_name The Default Hostname associated with the Static Site. - azurerm_static_web_app.static_site.default_host_name
api_key The API key of this Static Web App, which is used for later interacting with this Static Web App from other clients, ... - azurerm_static_web_app.static_site.api_key
custom_domain - {for key , value in try(var.custom_domains, {}) : key => {"id": "${azurerm_static_web_app_custom_domain.custom_domains[key].id}", "validation_token": "${azurerm_static_web_app_custom_domain.custom_domains[key].validation_token}"}}

Sources

  • modules/webapps/static_site/custom_domain.tf
  • modules/webapps/static_site/diagnostic.tf
  • modules/webapps/static_site/locals.tf
  • modules/webapps/static_site/main.tf
  • modules/webapps/static_site/managed_identities.tf
  • modules/webapps/static_site/module.tf
  • modules/webapps/static_site/outputs.tf
  • modules/webapps/static_site/variables.tf