Skip to content

Terraform module to provision a static web app with Azure Storage Account and Azure CDN.

License

Notifications You must be signed in to change notification settings

nventive/terraform-azurerm-static-web-app

Repository files navigation

nventive

terraform-azurerm-static-web-app

License Latest Release

Terraform module to provision a static web app with Azure Storage Account and Azure CDN.


Examples

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

module "this" {
  source  = "cloudposse/label/null"
  version = "0.25.0"

  namespace = "nventive"
  name      = "example"
}

resource "azurerm_resource_group" "example" {
  name     = module.this.id
  location = "Canada Central"
}

module "static_web_app" {
  source = "nventive/static-web-app/azurerm"
  # We recommend pinning every module to a specific version
  # version = "x.x.x"

  context = module.this.context

  resource_group_name     = azurerm_resource_group.example.name
  resource_group_location = azurerm_resource_group.example.location
  storage_account_name    = "examplestorage"
}

Requirements

No requirements.

Providers

Name Version
azurerm n/a

Modules

Name Source Version
azurerm_storage_account_label cloudposse/label/null 0.25.0
custom_domain_label cloudposse/label/null 0.25.0
this cloudposse/label/null 0.25.0

Resources

Name Type
azurerm_cdn_endpoint.default resource
azurerm_cdn_endpoint_custom_domain.default resource
azurerm_cdn_profile.default resource
azurerm_dns_cname_record.default resource
azurerm_dns_cname_record.verify_default resource
azurerm_storage_account.default resource
azurerm_dns_cname_record.default data source
azurerm_dns_zone.parent data source

Inputs

Name Description Type Default Required
additional_tag_map Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string) {} no
attributes ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
list(string) [] no
cdn_profile_sku n/a string "Standard_Microsoft" no
context Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"unset"
],
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
}
no
custom_sub_domain_name Subdomain to use, i.e.: use myapp as in myapp.contoso.com string null no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
string null no
descriptor_formats Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br> format = string<br> labels = list(string)<br>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
any {} no
enabled Set to false to prevent the module from creating any resources bool null no
environment ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' string null no
error_404_document n/a string "404.html" no
id_length_limit Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
number null no
index_document n/a string "index.html" no
label_key_case Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
string null no
label_order The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
list(string) null no
label_value_case Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
string null no
labels_as_tags Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
"default"
]
no
name ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
string null no
namespace ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique string null no
parent_dns_zone_name n/a string null no
parent_dns_zone_resource_group_name n/a string null no
regex_replace_chars Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
string null no
resource_group_location Location of the resource group to deploy the App Service to. string n/a yes
resource_group_name Name of the resource group to deploy the App Service to. string n/a yes
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
storage_account_name Specifies the name of the storage account. Only lowercase Alphanumeric characters allowed. Changing this forces a new resource to be created. This must be unique across the entire Azure service, not just within the resource group. string null no
storage_account_replication_type Defines the type of replication to use for this storage account. Valid options are LRS, GRS, RAGRS, ZRS, GZRS and RAGZRS. string "GRS" no
storage_account_tier Defines the Tier to use for this storage account. Valid options are Standard and Premium. For BlockBlobStorage and FileStorage accounts only Premium is valid. string "Standard" no
tags Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string) {} no
tenant ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for string null no
url_rewrites List of URL rewrites.
list(object({
name = string
request_url = string
source_pattern = string
destination = string
}))
[] no

Outputs

Name Description
cdn_endpoint_fqdn n/a
storage_account_name n/a

Breaking Changes

Please consult BREAKING_CHANGES.md for more information about version history and compatibility.

Contributing

Please read CONTRIBUTING.md for details on the process for contributing to this project.

Be mindful of our Code of Conduct.

We're hiring

Look for current openings on BambooHR https://nventive.bamboohr.com/careers/

Stay in touch

nventive.com | Linkedin | Instagram | YouTube | Spotify