You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes`|`string`|`"-"`| no |
204
-
| enabled | Set to false to prevent the module from creating any resources |`bool`|`true`| no |
205
-
| environment |The environment name if not using stage |`string`|`""`| no |
202
+
| context | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | <pre>object({<br> enabled = bool<br> namespace = string<br> environment = string<br> stage = string<br> name = string<br> delimiter = string<br> attributes = list(string)<br> tags = map(string)<br> additional_tag_map = map(string)<br> regex_replace_chars = string<br> label_order = list(string)<br> id_length_limit = number<br> })</pre> | <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_order": [],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {}<br>}</pre> | no |
203
+
| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes`.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. |`string`|`null`| no |
204
+
| enabled | Set to false to prevent the module from creating any resources |`bool`|`null`| no |
205
+
| environment |Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' |`string`|`null`| no |
206
206
| existing\_nat\_ips | Existing Elastic IPs to attach to the NAT Gateway or Instance instead of creating a new one. |`list(string)`|`[]`| no |
207
+
| id\_length\_limit | Limit `id` to this many characters.<br>Set to `0` for unlimited length.<br>Set to `null` for default, which is `0`.<br>Does not affect `id_full`. |`number`|`null`| no |
207
208
| igw\_id | Internet Gateway ID the public route table will point to (e.g. `igw-9c26a123`) |`string`| n/a | yes |
208
-
| label\_order | The naming order of the ID output and Name tag|`list(string)`|`[]`| no |
209
+
| label\_order | The naming order of the id output and Name tag.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 5 elements, but at least one must be present. |`list(string)`|`null`| no |
209
210
| map\_public\_ip\_on\_launch | Instances launched into a public subnet should be assigned a public IP address |`bool`|`true`| no |
210
211
| max\_subnet\_count | Sets the maximum amount of subnets to deploy. 0 will deploy a subnet for every provided availablility zone (in `availability_zones` variable) within the region |`number`|`0`| no |
211
-
| name | Solution name, e.g. 'app' or 'cluster' |`string`|`""`| no |
212
-
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' |`string`|`""`| no |
212
+
| name | Solution name, e.g. 'app' or 'jenkins' |`string`|`null`| no |
213
+
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' |`string`|`null`| no |
213
214
| nat\_gateway\_enabled | Flag to enable/disable NAT Gateways to allow servers in the private subnets to access the Internet |`bool`|`true`| no |
214
215
| nat\_instance\_enabled | Flag to enable/disable NAT Instances to allow servers in the private subnets to access the Internet |`bool`|`false`| no |
215
216
| nat\_instance\_type | NAT Instance type |`string`|`"t3.micro"`| no |
216
217
| private\_network\_acl\_id | Network ACL ID that will be added to private subnets. If empty, a new ACL will be created |`string`|`""`| no |
217
218
| private\_subnets\_additional\_tags | Additional tags to be added to private subnets |`map(string)`|`{}`| no |
218
219
| public\_network\_acl\_id | Network ACL ID that will be added to public subnets. If empty, a new ACL will be created |`string`|`""`| no |
219
220
| public\_subnets\_additional\_tags | Additional tags to be added to public subnets |`map(string)`|`{}`| no |
220
-
| regex\_replace\_chars | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. By default only hyphens, letters and digits are allowed, all other chars are removed |`string`|`"/[^a-zA-Z0-9-]/"`| no |
221
-
| stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test'|`string`|`""`| no |
221
+
| regex\_replace\_chars | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. |`string`|`null`| no |
222
+
| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
222
223
| subnet\_type\_tag\_key | Key for subnet type tag to provide information about the type of subnets, e.g. `cpco.io/subnet/type=private` or `cpco.io/subnet/type=public`|`string`|`"cpco.io/subnet/type"`| no |
223
224
| subnet\_type\_tag\_value\_format | This is using the format interpolation symbols to allow the value of the subnet\_type\_tag\_key to be modified. |`string`|`"%s"`| no |
224
-
| tags | Additional tags to apply to all resources that use this label module|`map(string)`|`{}`| no |
225
+
| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')`|`map(string)`|`{}`| no |
225
226
| vpc\_default\_route\_table\_id | Default route table for public subnets. If not set, will be created. (e.g. `rtb-f4f0ce12`) |`string`|`""`| no |
226
227
| vpc\_id | VPC ID where subnets will be created (e.g. `vpc-aceb2723`) |`string`| n/a | yes |
0 commit comments