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
| <aname="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map)| Additional tags for appending to tags\_as\_list\_of\_maps. Not added to `tags`. |`map(string)`|`{}`| no |
488
+
| <aname="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map)| Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. |`map(string)`|`{}`| no |
489
489
| <aname="input_alb_arn_suffix"></a> [alb\_arn\_suffix](#input\_alb\_arn\_suffix)| The ARN suffix of the ALB |`string`| n/a | yes |
490
490
| <aname="input_alb_dns_name"></a> [alb\_dns\_name](#input\_alb\_dns\_name)| DNS name of ALB |`string`| n/a | yes |
491
491
| <aname="input_alb_ingress_authenticated_hosts"></a> [alb\_ingress\_authenticated\_hosts](#input\_alb\_ingress\_authenticated\_hosts)| Authenticated hosts to match in Hosts header (a maximum of 1 can be defined) |`list(string)`|`[]`| no |
@@ -514,7 +514,7 @@ Available targets:
514
514
| <aname="input_atlantis_url_format"></a> [atlantis\_url\_format](#input\_atlantis\_url\_format)| Template for the Atlantis URL which is populated with the hostname |`string`|`"https://%s"`| no |
515
515
| <aname="input_atlantis_wake_word"></a> [atlantis\_wake\_word](#input\_atlantis\_wake\_word)| Wake world for atlantis |`string`|`"atlantis"`| no |
516
516
| <aname="input_atlantis_webhook_format"></a> [atlantis\_webhook\_format](#input\_atlantis\_webhook\_format)| Template for the Atlantis webhook URL which is populated with the hostname |`string`|`"https://%s/events"`| no |
517
-
| <aname="input_attributes"></a> [attributes](#input\_attributes)| Additional attributes (e.g. `1`)|`list(string)`|`[]`| no |
517
+
| <aname="input_attributes"></a> [attributes](#input\_attributes)|ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element.|`list(string)`|`[]`| no |
518
518
| <aname="input_authentication_cognito_user_pool_arn"></a> [authentication\_cognito\_user\_pool\_arn](#input\_authentication\_cognito\_user\_pool\_arn)| Cognito User Pool ARN |`string`|`""`| no |
519
519
| <aname="input_authentication_cognito_user_pool_arn_ssm_name"></a> [authentication\_cognito\_user\_pool\_arn\_ssm\_name](#input\_authentication\_cognito\_user\_pool\_arn\_ssm\_name)| SSM param name to lookup `authentication_cognito_user_pool_arn` if not provided |`string`|`""`| no |
520
520
| <aname="input_authentication_cognito_user_pool_client_id"></a> [authentication\_cognito\_user\_pool\_client\_id](#input\_authentication\_cognito\_user\_pool\_client\_id)| Cognito User Pool Client ID |`string`|`""`| no |
@@ -542,9 +542,10 @@ Available targets:
542
542
| <aname="input_container_cpu"></a> [container\_cpu](#input\_container\_cpu)| Atlantis CPUs per task |`number`|`256`| no |
543
543
| <aname="input_container_memory"></a> [container\_memory](#input\_container\_memory)| Atlantis memory per task |`number`|`512`| no |
544
544
| <aname="input_container_repo_credentials"></a> [container\_repo\_credentials](#input\_container\_repo\_credentials)| Container repository credentials; required when using a private repo. This map currently supports a single key; "credentialsParameter", which should be the ARN of a Secrets Manager's secret holding the credentials |`map(string)`|`null`| no |
545
-
| <aname="input_context"></a> [context](#input\_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. |`any`| <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {}<br>}</pre> | no |
545
+
| <aname="input_context"></a> [context](#input\_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. |`any`| <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre> | no |
546
546
| <aname="input_default_backend_image"></a> [default\_backend\_image](#input\_default\_backend\_image)| ECS default (bootstrap) image |`string`|`"cloudposse/default-backend:0.1.2"`| no |
547
-
| <aname="input_delimiter"></a> [delimiter](#input\_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 |
547
+
| <aname="input_delimiter"></a> [delimiter](#input\_delimiter)| Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. |`string`|`null`| no |
548
+
| <aname="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats)| Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br> format = string<br> labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). |`any`|`{}`| no |
548
549
| <aname="input_desired_count"></a> [desired\_count](#input\_desired\_count)| Atlantis desired number of tasks |`number`|`1`| no |
549
550
| <aname="input_ecs_alarms_cpu_utilization_high_alarm_actions"></a> [ecs\_alarms\_cpu\_utilization\_high\_alarm\_actions](#input\_ecs\_alarms\_cpu\_utilization\_high\_alarm\_actions)| A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization High Alarm action |`list(string)`|`[]`| no |
550
551
| <aname="input_ecs_alarms_cpu_utilization_high_ok_actions"></a> [ecs\_alarms\_cpu\_utilization\_high\_ok\_actions](#input\_ecs\_alarms\_cpu\_utilization\_high\_ok\_actions)| A list of ARNs (i.e. SNS Topic ARN) to notify on CPU Utilization High OK action |`list(string)`|`[]`| no |
@@ -558,35 +559,37 @@ Available targets:
558
559
| <aname="input_ecs_cluster_arn"></a> [ecs\_cluster\_arn](#input\_ecs\_cluster\_arn)| ARN of the ECS cluster to deploy Atlantis |`string`| n/a | yes |
559
560
| <aname="input_ecs_cluster_name"></a> [ecs\_cluster\_name](#input\_ecs\_cluster\_name)| Name of the ECS cluster to deploy Atlantis |`string`| n/a | yes |
560
561
| <aname="input_enabled"></a> [enabled](#input\_enabled)| Set to false to prevent the module from creating any resources |`bool`|`null`| no |
561
-
| <aname="input_environment"></a> [environment](#input\_environment)|Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' |`string`|`null`| no |
562
+
| <aname="input_environment"></a> [environment](#input\_environment)|ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' |`string`|`null`| no |
562
563
| <aname="input_github_oauth_token"></a> [github\_oauth\_token](#input\_github\_oauth\_token)| GitHub OAuth token. If not provided the token is looked up from SSM |`string`|`""`| no |
563
564
| <aname="input_github_oauth_token_ssm_name"></a> [github\_oauth\_token\_ssm\_name](#input\_github\_oauth\_token\_ssm\_name)| SSM param name to lookup `github_oauth_token` if not provided |`string`|`""`| no |
564
565
| <aname="input_github_webhooks_token"></a> [github\_webhooks\_token](#input\_github\_webhooks\_token)| GitHub OAuth Token with permissions to create webhooks. If not provided the token is looked up from SSM |`string`|`""`| no |
565
566
| <aname="input_github_webhooks_token_ssm_name"></a> [github\_webhooks\_token\_ssm\_name](#input\_github\_webhooks\_token\_ssm\_name)| SSM param name to lookup `github_webhooks_token` if not provided |`string`|`""`| no |
566
567
| <aname="input_healthcheck_path"></a> [healthcheck\_path](#input\_healthcheck\_path)| Healthcheck path |`string`|`"/healthz"`| no |
567
568
| <aname="input_hostname"></a> [hostname](#input\_hostname)| Atlantis URL |`string`|`""`| no |
568
-
| <aname="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit)| Limit `id` to this many characters (minimum 6).<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 |
569
+
| <aname="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit)| Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to`0`.<br>Does not affect `id_full`. |`number`|`null`| no |
569
570
| <aname="input_kms_key_id"></a> [kms\_key\_id](#input\_kms\_key\_id)| KMS key ID used to encrypt SSM SecureString parameters |`string`|`""`| no |
570
-
| <aname="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case)| The letter case of label keys (`tag` names) (i.e. `name`, `namespace`, `environment`, `stage`, `attributes`) to use in `tags`.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. |`string`|`null`| no |
571
-
| <aname="input_label_order"></a> [label\_order](#input\_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 |
572
-
| <aname="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case)| The letter case of output label values (also used in `tags` and `id`).<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Default value: `lower`. |`string`|`null`| no |
571
+
| <aname="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case)| Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. |`string`|`null`| no |
572
+
| <aname="input_label_order"></a> [label\_order](#input\_label\_order)| The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. |`list(string)`|`null`| no |
573
+
| <aname="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case)| Controls the letter case of ID elements (labels) as included in `id`,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br>Default value: `lower`. |`string`|`null`| no |
574
+
| <aname="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags)| Set of labels (ID elements) to include as tags in the `tags` output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the `tags` output.<br>Set to `[]` to suppress all generated tags.<br>**Notes:**<br> The value of the `name` tag, if included, will be the `id`, not the `name`.<br> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored. |`set(string)`| <pre>[<br> "default"<br>]</pre> | no |
573
575
| <aname="input_launch_type"></a> [launch\_type](#input\_launch\_type)| The ECS launch type (valid options: FARGATE or EC2) |`string`|`"FARGATE"`| no |
574
-
| <aname="input_name"></a> [name](#input\_name)|Solution name, e.g. 'app' or 'jenkins' |`string`|`null`| no |
575
-
| <aname="input_namespace"></a> [namespace](#input\_namespace)|Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' |`string`|`null`| no |
576
+
| <aname="input_name"></a> [name](#input\_name)|ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.|`string`|`null`| no |
577
+
| <aname="input_namespace"></a> [namespace](#input\_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 |
576
578
| <aname="input_overwrite_ssm_parameter"></a> [overwrite\_ssm\_parameter](#input\_overwrite\_ssm\_parameter)| Whether to overwrite an existing SSM parameter |`bool`|`true`| no |
577
579
| <aname="input_parent_zone_id"></a> [parent\_zone\_id](#input\_parent\_zone\_id)| The zone ID where the DNS record for the `short_name` will be written |`string`|`""`| no |
578
580
| <aname="input_policy_arn"></a> [policy\_arn](#input\_policy\_arn)| Permission to grant to atlantis server |`string`|`"arn:aws:iam::aws:policy/AdministratorAccess"`| no |
579
581
| <aname="input_private_subnet_ids"></a> [private\_subnet\_ids](#input\_private\_subnet\_ids)| The private subnet IDs |`list(string)`|`[]`| no |
580
-
| <aname="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_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 |
582
+
| <aname="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars)|Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. |`string`|`null`| no |
581
583
| <aname="input_region"></a> [region](#input\_region)| AWS Region for S3 bucket |`string`| n/a | yes |
582
584
| <aname="input_repo_name"></a> [repo\_name](#input\_repo\_name)| GitHub repository name of the atlantis to be built and deployed to ECS. |`string`| n/a | yes |
| <aname="input_security_group_ids"></a> [security\_group\_ids](#input\_security\_group\_ids)| Additional Security Group IDs to allow into ECS Service. |`list(string)`|`[]`| no |
585
587
| <aname="input_short_name"></a> [short\_name](#input\_short\_name)| Alantis short DNS name (e.g. `atlantis`) |`string`|`"atlantis"`| no |
586
588
| <aname="input_ssh_private_key_name"></a> [ssh\_private\_key\_name](#input\_ssh\_private\_key\_name)| Atlantis SSH private key name |`string`|`"atlantis_ssh_private_key"`| no |
587
589
| <aname="input_ssh_public_key_name"></a> [ssh\_public\_key\_name](#input\_ssh\_public\_key\_name)| Atlantis SSH public key name |`string`|`"atlantis_ssh_public_key"`| no |
588
-
| <aname="input_stage"></a> [stage](#input\_stage)| Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
589
-
| <aname="input_tags"></a> [tags](#input\_tags)| Additional tags (e.g. `map('BusinessUnit','XYZ')`|`map(string)`|`{}`| no |
590
+
| <aname="input_stage"></a> [stage](#input\_stage)| ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
591
+
| <aname="input_tags"></a> [tags](#input\_tags)| Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module. |`map(string)`|`{}`| no |
592
+
| <aname="input_tenant"></a> [tenant](#input\_tenant)| ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for |`string`|`null`| no |
590
593
| <aname="input_use_alb_security_group"></a> [use\_alb\_security\_group](#input\_use\_alb\_security\_group)| A flag to enable/disable adding the ingress rule to the ALB security group |`bool`|`true`| no |
591
594
| <aname="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id)| VPC ID for the ECS Cluster |`string`| n/a | yes |
592
595
| <aname="input_webhook_enabled"></a> [webhook\_enabled](#input\_webhook\_enabled)| Set to false to prevent the module from creating any webhook resources |`bool`|`true`| no |
@@ -662,6 +665,7 @@ Like this project? Please give it a ★ on [our GitHub](https://github.com/cloud
662
665
Are you using this project or any of our other projects? Consider [leaving a testimonial][testimonial]. =)
663
666
664
667
668
+
665
669
## Related Projects
666
670
667
671
Check out these related projects.
@@ -677,8 +681,6 @@ Check out these related projects.
677
681
-[terraform-aws-lb-s3-bucket](https://github.com/cloudposse/terraform-aws-lb-s3-bucket) - Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs.
678
682
679
683
680
-
681
-
682
684
## References
683
685
684
686
For additional context, refer to some of these links.
0 commit comments