|
| 1 | +# |
| 2 | +# ONLY EDIT THIS FILE IN github.com/cloudposse/terraform-null-label |
| 3 | +# All other instances of this file should be a copy of that one |
| 4 | +# |
| 5 | +# |
| 6 | +# Copy this file from https://github.com/cloudposse/terraform-null-label/blob/master/exports/context.tf |
| 7 | +# and then place it in your Terraform module to automatically get |
| 8 | +# Cloud Posse's standard configuration inputs suitable for passing |
| 9 | +# to Cloud Posse modules. |
| 10 | +# |
| 11 | +# Modules should access the whole context as `module.this.context` |
| 12 | +# to get the input variables with nulls for defaults, |
| 13 | +# for example `context = module.this.context`, |
| 14 | +# and access individual variables as `module.this.<var>`, |
| 15 | +# with final values filled in. |
| 16 | +# |
| 17 | +# For example, when using defaults, `module.this.context.delimiter` |
| 18 | +# will be null, and `module.this.delimiter` will be `-` (hyphen). |
| 19 | +# |
| 20 | + |
| 21 | +module "this" { |
| 22 | + source = "git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.19.2" |
| 23 | + |
| 24 | + enabled = var.enabled |
| 25 | + namespace = var.namespace |
| 26 | + environment = var.environment |
| 27 | + stage = var.stage |
| 28 | + name = var.name |
| 29 | + delimiter = var.delimiter |
| 30 | + attributes = var.attributes |
| 31 | + tags = var.tags |
| 32 | + additional_tag_map = var.additional_tag_map |
| 33 | + label_order = var.label_order |
| 34 | + regex_replace_chars = var.regex_replace_chars |
| 35 | + id_length_limit = var.id_length_limit |
| 36 | + |
| 37 | + context = var.context |
| 38 | +} |
| 39 | + |
| 40 | +# Copy contents of cloudposse/terraform-null-label/variables.tf here |
| 41 | + |
| 42 | +variable "context" { |
| 43 | + type = object({ |
| 44 | + enabled = bool |
| 45 | + namespace = string |
| 46 | + environment = string |
| 47 | + stage = string |
| 48 | + name = string |
| 49 | + delimiter = string |
| 50 | + attributes = list(string) |
| 51 | + tags = map(string) |
| 52 | + additional_tag_map = map(string) |
| 53 | + regex_replace_chars = string |
| 54 | + label_order = list(string) |
| 55 | + id_length_limit = number |
| 56 | + }) |
| 57 | + default = { |
| 58 | + enabled = true |
| 59 | + namespace = null |
| 60 | + environment = null |
| 61 | + stage = null |
| 62 | + name = null |
| 63 | + delimiter = null |
| 64 | + attributes = [] |
| 65 | + tags = {} |
| 66 | + additional_tag_map = {} |
| 67 | + regex_replace_chars = null |
| 68 | + label_order = [] |
| 69 | + id_length_limit = null |
| 70 | + } |
| 71 | + description = <<-EOT |
| 72 | + Single object for setting entire context at once. |
| 73 | + See description of individual variables for details. |
| 74 | + Leave string and numeric variables as `null` to use default value. |
| 75 | + Individual variable settings (non-null) override settings in context object, |
| 76 | + except for attributes, tags, and additional_tag_map, which are merged. |
| 77 | + EOT |
| 78 | +} |
| 79 | + |
| 80 | +variable "enabled" { |
| 81 | + type = bool |
| 82 | + default = null |
| 83 | + description = "Set to false to prevent the module from creating any resources" |
| 84 | +} |
| 85 | + |
| 86 | +variable "namespace" { |
| 87 | + type = string |
| 88 | + default = null |
| 89 | + description = "Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'" |
| 90 | +} |
| 91 | + |
| 92 | +variable "environment" { |
| 93 | + type = string |
| 94 | + default = null |
| 95 | + description = "Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT'" |
| 96 | +} |
| 97 | + |
| 98 | +variable "stage" { |
| 99 | + type = string |
| 100 | + default = null |
| 101 | + description = "Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'" |
| 102 | +} |
| 103 | + |
| 104 | +variable "name" { |
| 105 | + type = string |
| 106 | + default = null |
| 107 | + description = "Solution name, e.g. 'app' or 'jenkins'" |
| 108 | +} |
| 109 | + |
| 110 | +variable "delimiter" { |
| 111 | + type = string |
| 112 | + default = null |
| 113 | + description = <<-EOT |
| 114 | + Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes`. |
| 115 | + Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. |
| 116 | + EOT |
| 117 | +} |
| 118 | + |
| 119 | +variable "attributes" { |
| 120 | + type = list(string) |
| 121 | + default = [] |
| 122 | + description = "Additional attributes (e.g. `1`)" |
| 123 | +} |
| 124 | + |
| 125 | +variable "tags" { |
| 126 | + type = map(string) |
| 127 | + default = {} |
| 128 | + description = "Additional tags (e.g. `map('BusinessUnit','XYZ')`" |
| 129 | +} |
| 130 | + |
| 131 | +variable "additional_tag_map" { |
| 132 | + type = map(string) |
| 133 | + default = {} |
| 134 | + description = "Additional tags for appending to tags_as_list_of_maps. Not added to `tags`." |
| 135 | +} |
| 136 | + |
| 137 | +variable "label_order" { |
| 138 | + type = list(string) |
| 139 | + default = null |
| 140 | + description = <<-EOT |
| 141 | + The naming order of the id output and Name tag. |
| 142 | + Defaults to ["namespace", "environment", "stage", "name", "attributes"]. |
| 143 | + You can omit any of the 5 elements, but at least one must be present. |
| 144 | + EOT |
| 145 | +} |
| 146 | + |
| 147 | +variable "regex_replace_chars" { |
| 148 | + type = string |
| 149 | + default = null |
| 150 | + description = <<-EOT |
| 151 | + Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. |
| 152 | + If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. |
| 153 | + EOT |
| 154 | +} |
| 155 | + |
| 156 | +variable "id_length_limit" { |
| 157 | + type = number |
| 158 | + default = null |
| 159 | + description = <<-EOT |
| 160 | + Limit `id` to this many characters. |
| 161 | + Set to `0` for unlimited length. |
| 162 | + Set to `null` for default, which is `0`. |
| 163 | + Does not affect `id_full`. |
| 164 | + EOT |
| 165 | +} |
| 166 | + |
| 167 | +#### End of copy of cloudposse/terraform-null-label/variables.tf |
0 commit comments