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 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 |
95
-
| <aname="input_ami"></a> [ami](#input\_ami)| AMI to use for the instance. Setting this will ignore `ami_filter` and `ami_owners`. |`string`|`null`| no |
96
-
| <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 |
97
-
| <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 |
98
-
| <aname="input_assign_eip_address"></a> [assign\_eip\_address](#input\_assign\_eip\_address)| Assign an Elastic IP address to the instance |`bool`|`true`| no |
99
-
| <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 |
100
-
| <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 |
101
-
| <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 |
102
-
| <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 |
103
-
| <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 |
106
-
| <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 |
107
-
| <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 |
108
-
| <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 |
109
-
| <aname="input_ebs_snapshot_id"></a> [ebs\_snapshot\_id](#input\_ebs\_snapshot\_id)| The snapshot id to use for the EBS block device |`string`|`""`| no |
110
-
| <aname="input_enabled"></a> [enabled](#input\_enabled)| Set to false to prevent the module from creating any resources |`bool`|`null`| no |
111
-
| <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 |
112
-
| <aname="input_host_name"></a> [host\_name](#input\_host\_name)| The Bastion hostname created in Route53 |`string`|`"bastion"`| no |
113
-
| <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 |
114
-
| <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 |
115
-
| <aname="input_instance_type"></a> [instance\_type](#input\_instance\_type)| Bastion instance type |`string`|`"t2.micro"`| no |
116
-
| <aname="input_key_name"></a> [key\_name](#input\_key\_name)| Key name |`string`|`""`| no |
117
-
| <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 |
118
-
| <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 |
119
-
| <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 |
120
-
| <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 |
121
-
| <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 |
122
-
| <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 |
123
-
| <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 |
124
-
| <aname="input_monitoring"></a> [monitoring](#input\_monitoring)| Launched EC2 instance will have detailed monitoring enabled |`bool`|`true`| no |
125
-
| <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 |
126
-
| <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 |
127
-
| <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 |
128
-
| <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 |
129
-
| <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 |
130
-
| <aname="input_security_group_description"></a> [security\_group\_description](#input\_security\_group\_description)| The Security Group description. |`string`|`"Bastion host security group"`| no |
131
-
| <aname="input_security_group_enabled"></a> [security\_group\_enabled](#input\_security\_group\_enabled)| Whether to create default Security Group for bastion host. |`bool`|`true`| no |
132
-
| <aname="input_security_group_rules"></a> [security\_group\_rules](#input\_security\_group\_rules)| A list of maps of Security Group rules. <br/>The values of map is fully complated with `aws_security_group_rule` resource. <br/>To get more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule . |`list(any)`| <pre>[<br/> {<br/> "cidr_blocks": [<br/> "0.0.0.0/0"<br/> ],<br/> "description": "Allow all outbound traffic",<br/> "from_port": 0,<br/> "protocol": -1,<br/> "to_port": 0,<br/> "type": "egress"<br/> },<br/> {<br/> "cidr_blocks": [<br/> "0.0.0.0/0"<br/> ],<br/> "description": "Allow all inbound to SSH",<br/> "from_port": 22,<br/> "protocol": "tcp",<br/> "to_port": 22,<br/> "type": "ingress"<br/> }<br/>]</pre> | no |
133
-
| <aname="input_security_group_use_name_prefix"></a> [security\_group\_use\_name\_prefix](#input\_security\_group\_use\_name\_prefix)| Whether to create a default Security Group with unique name beginning with the normalized prefix. |`bool`|`false`| no |
134
-
| <aname="input_security_groups"></a> [security\_groups](#input\_security\_groups)| A list of Security Group IDs to associate with bastion host. |`list(string)`|`[]`| no |
135
-
| <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 |
136
-
| <aname="input_ssm_enabled"></a> [ssm\_enabled](#input\_ssm\_enabled)| Enable SSM Agent on Host. |`bool`|`true`| no |
137
-
| <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. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module. |`map(string)`|`{}`| no |
140
-
| <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 |
141
-
| <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 |
142
-
| <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 |
143
-
| <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 |
144
-
| <aname="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id)| VPC ID |`string`| n/a | yes |
145
-
| <aname="input_zone_id"></a> [zone\_id](#input\_zone\_id)| Route53 DNS Zone ID |`string`|`""`| no |
146
-
147
-
## Outputs
148
-
149
-
| Name | Description |
150
-
|------|-------------|
151
-
| <aname="output_arn"></a> [arn](#output\_arn)| ARN of the instance |
152
-
| <aname="output_hostname"></a> [hostname](#output\_hostname)| DNS hostname |
153
-
| <aname="output_id"></a> [id](#output\_id)| Disambiguated ID of the instance |
154
-
| <aname="output_instance_id"></a> [instance\_id](#output\_instance\_id)| Instance ID |
155
-
| <aname="output_name"></a> [name](#output\_name)| Instance name |
156
-
| <aname="output_private_dns"></a> [private\_dns](#output\_private\_dns)| Private DNS of instance |
157
-
| <aname="output_private_ip"></a> [private\_ip](#output\_private\_ip)| Private IP of the instance |
158
-
| <aname="output_public_dns"></a> [public\_dns](#output\_public\_dns)| Public DNS of instance (or DNS of EIP) |
159
-
| <aname="output_public_ip"></a> [public\_ip](#output\_public\_ip)| Public IP of the instance (or EIP) |
160
-
| <aname="output_role"></a> [role](#output\_role)| Name of AWS IAM Role associated with the instance |
161
-
| <aname="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn)| Bastion host Security Group ARN |
162
-
| <aname="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id)| Bastion host Security Group ID |
163
-
| <aname="output_security_group_ids"></a> [security\_group\_ids](#output\_security\_group\_ids)| IDs on the AWS Security Groups associated with the instance |
164
-
| <aname="output_security_group_name"></a> [security\_group\_name](#output\_security\_group\_name)| Bastion host Security Group name |
165
-
| <aname="output_ssh_user"></a> [ssh\_user](#output\_ssh\_user)| SSH user |
0 commit comments