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 |
144
+
| <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 |
145
145
| <aname="input_ami_filter"></a> [ami\_filter](#input\_ami\_filter)| List of maps used to create the AMI filter for the action runner AMI. |`map(list(string))`| <pre>{<br> "name": [<br> "amzn2-ami-hvm-2.*-x86_64-ebs"<br> ]<br>}</pre> | no |
146
146
| <aname="input_ami_owners"></a> [ami\_owners](#input\_ami\_owners)| The list of owners used to select the AMI of action runner instances. |`list(string)`| <pre>[<br> "amazon"<br>]</pre> | no |
147
147
| <aname="input_assign_eip_address"></a> [assign\_eip\_address](#input\_assign\_eip\_address)| Assign an Elastic IP address to the instance |`bool`|`true`| no |
148
148
| <aname="input_associate_public_ip_address"></a> [associate\_public\_ip\_address](#input\_associate\_public\_ip\_address)| Whether to associate a public IP to the instance. |`bool`|`false`| no |
149
-
| <aname="input_attributes"></a> [attributes](#input\_attributes)| Additional attributes (e.g. `1`) |`list(string)`|`[]`| no |
150
-
| <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 |
151
-
| <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 |
149
+
| <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 |
150
+
| <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 |
151
+
| <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 |
152
+
| <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 |
| <aname="input_ebs_block_device_encrypted"></a> [ebs\_block\_device\_encrypted](#input\_ebs\_block\_device\_encrypted)| Whether to encrypt the EBS block device |`bool`|`true`| no |
154
155
| <aname="input_ebs_block_device_volume_size"></a> [ebs\_block\_device\_volume\_size](#input\_ebs\_block\_device\_volume\_size)| The volume size (in GiB) to provision for the EBS block device. Creation skipped if size is 0 |`number`|`0`| no |
155
156
| <aname="input_ebs_delete_on_termination"></a> [ebs\_delete\_on\_termination](#input\_ebs\_delete\_on\_termination)| Whether the EBS volume should be destroyed on instance termination |`bool`|`true`| no |
156
157
| <aname="input_ebs_device_name"></a> [ebs\_device\_name](#input\_ebs\_device\_name)| The name of the EBS block device to mount on the instance |`string`|`"/dev/sdh"`| no |
157
158
| <aname="input_enabled"></a> [enabled](#input\_enabled)| Set to false to prevent the module from creating any resources |`bool`|`null`| no |
158
-
| <aname="input_environment"></a> [environment](#input\_environment)|Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' |`string`|`null`| no |
159
+
| <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 |
159
160
| <aname="input_host_name"></a> [host\_name](#input\_host\_name)| The Bastion hostname created in Route53 |`string`|`"bastion"`| no |
160
-
| <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 |
161
+
| <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 |
161
162
| <aname="input_instance_profile"></a> [instance\_profile](#input\_instance\_profile)| A pre-defined profile to attach to the instance (default is to build our own) |`string`|`""`| no |
162
163
| <aname="input_instance_type"></a> [instance\_type](#input\_instance\_type)| Bastion instance type |`string`|`"t2.micro"`| no |
163
164
| <aname="input_key_name"></a> [key\_name](#input\_key\_name)| Key name |`string`|`""`| no |
164
-
| <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 |
165
-
| <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 |
166
-
| <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 |
165
+
| <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 |
166
+
| <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 |
167
+
| <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 |
168
+
| <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 |
167
169
| <aname="input_metadata_http_endpoint_enabled"></a> [metadata\_http\_endpoint\_enabled](#input\_metadata\_http\_endpoint\_enabled)| Whether the metadata service is available |`bool`|`true`| no |
168
170
| <aname="input_metadata_http_put_response_hop_limit"></a> [metadata\_http\_put\_response\_hop\_limit](#input\_metadata\_http\_put\_response\_hop\_limit)| The desired HTTP PUT response hop limit (between 1 and 64) for instance metadata requests. |`number`|`1`| no |
169
171
| <aname="input_metadata_http_tokens_required"></a> [metadata\_http\_tokens\_required](#input\_metadata\_http\_tokens\_required)| Whether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2. |`bool`|`true`| no |
170
172
| <aname="input_monitoring"></a> [monitoring](#input\_monitoring)| Launched EC2 instance will have detailed monitoring enabled |`bool`|`true`| no |
171
-
| <aname="input_name"></a> [name](#input\_name)|Solution name, e.g. 'app' or 'jenkins' |`string`|`null`| no |
172
-
| <aname="input_namespace"></a> [namespace](#input\_namespace)|Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' |`string`|`null`| no |
173
-
| <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 |
173
+
| <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 |
174
+
| <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 |
175
+
| <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 |
174
176
| <aname="input_root_block_device_encrypted"></a> [root\_block\_device\_encrypted](#input\_root\_block\_device\_encrypted)| Whether to encrypt the root block device |`bool`|`true`| no |
175
177
| <aname="input_root_block_device_volume_size"></a> [root\_block\_device\_volume\_size](#input\_root\_block\_device\_volume\_size)| The volume size (in GiB) to provision for the root block device. It cannot be smaller than the AMI it refers to. |`number`|`8`| no |
176
178
| <aname="input_security_group_description"></a> [security\_group\_description](#input\_security\_group\_description)| The Security Group description. |`string`|`"Bastion host security group"`| no |
@@ -180,9 +182,10 @@ Available targets:
180
182
| <aname="input_security_groups"></a> [security\_groups](#input\_security\_groups)| A list of Security Group IDs to associate with bastion host. |`list(string)`|`[]`| no |
181
183
| <aname="input_ssh_user"></a> [ssh\_user](#input\_ssh\_user)| Default SSH user for this AMI. e.g. `ec2-user` for Amazon Linux and `ubuntu` for Ubuntu systems |`string`|`"ec2-user"`| no |
182
184
| <aname="input_ssm_enabled"></a> [ssm\_enabled](#input\_ssm\_enabled)| Enable SSM Agent on Host. |`bool`|`true`| no |
183
-
| <aname="input_stage"></a> [stage](#input\_stage)|Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
185
+
| <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 |
| <aname="input_tags"></a> [tags](#input\_tags)| Additional tags (e.g. `map('BusinessUnit','XYZ')`|`map(string)`|`{}`| no |
187
+
| <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 |
188
+
| <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 |
186
189
| <aname="input_user_data"></a> [user\_data](#input\_user\_data)| User data content. Will be ignored if `user_data_base64` is set |`list(string)`|`[]`| no |
187
190
| <aname="input_user_data_base64"></a> [user\_data\_base64](#input\_user\_data\_base64)| The Base64-encoded user data to provide when launching the instances. If this is set then `user_data` will not be used. |`string`|`""`| no |
188
191
| <aname="input_user_data_template"></a> [user\_data\_template](#input\_user\_data\_template)| User Data template to use for provisioning EC2 Bastion Host |`string`|`"user_data/amazon-linux.sh"`| no |
@@ -299,7 +302,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
0 commit comments