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
| additional\_ips\_count | Count of additional EIPs |`number`|`0`| no |
151
-
| allowed\_ports | List of allowed ingress ports |`list(number)`|`[]`| no |
152
+
| additional\_tag\_map | Additional tags for appending to tags\_as\_list\_of\_maps. Not added to `tags`. |`map(string)`|`{}`| no |
153
+
| allowed\_ports | List of allowed ingress TCP ports |`list(number)`|`[]`| no |
154
+
| allowed\_ports\_udp | List of allowed ingress UDP ports |`list(number)`|`[]`| no |
152
155
| ami | The AMI to use for the instance. By default it is the AMI provided by Amazon with Ubuntu 16.04 |`string`|`""`| no |
153
156
| ami\_owner | Owner of the given AMI (ignored if `ami` unset) |`string`|`""`| no |
154
157
| applying\_period | The period in seconds over which the specified statistic is applied |`number`|`60`| no |
@@ -157,43 +160,47 @@ Available targets:
157
160
| attributes | Additional attributes (e.g. `1`) |`list(string)`|`[]`| no |
158
161
| availability\_zone | Availability Zone the instance is launched in. If not set, will be launched in the first AZ of the region |`string`|`""`| no |
159
162
| comparison\_operator | The arithmetic operation to use when comparing the specified Statistic and Threshold. Possible values are: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold. |`string`|`"GreaterThanOrEqualToThreshold"`| no |
163
+
| 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 |
160
164
| create\_default\_security\_group | Create default Security Group with only Egress traffic allowed |`bool`|`true`| no |
161
-
| default\_alarm\_action | Default alerm action |`string`|`"action/actions/AWS_EC2.InstanceId.Reboot/1.0"`| no |
165
+
| default\_alarm\_action | Default alarm action |`string`|`"action/actions/AWS_EC2.InstanceId.Reboot/1.0"`| no |
162
166
| delete\_on\_termination | Whether the volume should be destroyed on instance termination |`bool`|`true`| no |
163
-
| delimiter | Delimiter to be used between `name`, `namespace`, `stage`, etc. |`string`|`"-"`| no |
167
+
| 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 |
| ebs\_device\_name | Name of the EBS device to mount |`list(string)`| <pre>[<br> "/dev/xvdb",<br> "/dev/xvdc",<br> "/dev/xvdd",<br> "/dev/xvde",<br> "/dev/xvdf",<br> "/dev/xvdg",<br> "/dev/xvdh",<br> "/dev/xvdi",<br> "/dev/xvdj",<br> "/dev/xvdk",<br> "/dev/xvdl",<br> "/dev/xvdm",<br> "/dev/xvdn",<br> "/dev/xvdo",<br> "/dev/xvdp",<br> "/dev/xvdq",<br> "/dev/xvdr",<br> "/dev/xvds",<br> "/dev/xvdt",<br> "/dev/xvdu",<br> "/dev/xvdv",<br> "/dev/xvdw",<br> "/dev/xvdx",<br> "/dev/xvdy",<br> "/dev/xvdz"<br>]</pre> | no |
166
170
| ebs\_iops | Amount of provisioned IOPS. This must be set with a volume\_type of io1 |`number`|`0`| no |
167
171
| ebs\_optimized | Launched EC2 instance will be EBS-optimized |`bool`|`false`| no |
168
172
| ebs\_volume\_count | Count of EBS volumes that will be attached to the instance |`number`|`0`| no |
169
173
| ebs\_volume\_size | Size of the EBS volume in gigabytes |`number`|`10`| no |
170
174
| ebs\_volume\_type | The type of EBS volume. Can be standard, gp2 or io1 |`string`|`"gp2"`| no |
171
-
| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' |`string`|`""`| no |
175
+
| enabled | Set to false to prevent the module from creating any resources |`bool`|`null`| no |
176
+
| environment | Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' |`string`|`null`| no |
172
177
| evaluation\_periods | The number of periods over which data is compared to the specified threshold. |`number`|`5`| no |
173
-
|instance\_enabled|Flag to control the instance creation. Set to false if it is necessary to skip instance creation |`bool`|`true`| no |
178
+
|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 |
174
179
| instance\_profile | A pre-defined profile to attach to the instance (default is to build our own) |`string`|`""`| no |
175
180
| instance\_type | The type of the instance |`string`|`"t2.micro"`| no |
176
181
| ipv6\_address\_count | Number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet (-1 to use subnet default) |`number`|`0`| no |
177
182
| ipv6\_addresses | List of IPv6 addresses from the range of the subnet to associate with the primary network interface |`list(string)`|`[]`| no |
183
+
| 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 |
178
184
| metric\_name | The name for the alarm's associated metric. Allowed values can be found in https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ec2-metricscollected.html|`string`|`"StatusCheckFailed_Instance"`| no |
179
185
| metric\_namespace | The namespace for the alarm's associated metric. Allowed values can be found in https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-namespaces.html|`string`|`"AWS/EC2"`| no |
180
186
| metric\_threshold | The value against which the specified statistic is compared |`number`|`1`| no |
181
187
| monitoring | Launched EC2 instance will have detailed monitoring enabled |`bool`|`true`| no |
182
-
| name |Name (e.g. `bastion` or `db`)|`string`|n/a|yes|
183
-
| namespace | Namespace (e.g. `cp` or `cloudposse`)|`string`|`""`| no |
188
+
| name |Solution name, e.g. 'app' or 'jenkins'|`string`|`null`|no|
189
+
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'|`string`|`null`| no |
184
190
| permissions\_boundary\_arn | Policy ARN to attach to instance role as a permissions boundary |`string`|`""`| no |
185
191
| private\_ip | Private IP address to associate with the instance in the VPC |`string`|`""`| no |
192
+
| 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 |
186
193
| region | AWS Region the instance is launched in |`string`|`""`| no |
187
194
| root\_iops | Amount of provisioned IOPS. This must be set if root\_volume\_type is set to `io1`|`number`|`0`| no |
188
195
| root\_volume\_size | Size of the root volume in gigabytes |`number`|`10`| no |
189
196
| root\_volume\_type | Type of root volume. Can be standard, gp2 or io1 |`string`|`"gp2"`| no |
190
197
| security\_groups | List of Security Group IDs allowed to connect to the instance |`list(string)`|`[]`| no |
191
198
| source\_dest\_check | Controls if traffic is routed to the instance when the destination address does not match the instance. Used for NAT or VPNs |`bool`|`true`| no |
192
199
| ssh\_key\_pair | SSH key pair to be provisioned on the instance |`string`| n/a | yes |
193
-
| stage | Stage (e.g. `prod`, `dev`, `staging`|`string`|`""`| no |
200
+
| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
194
201
| statistic\_level | The statistic to apply to the alarm's associated metric. Allowed values are: SampleCount, Average, Sum, Minimum, Maximum |`string`|`"Maximum"`| no |
195
202
| subnet | VPC Subnet ID the instance is launched in |`string`| n/a | yes |
196
-
| tags | Additional tags |`map(string)`|`{}`| no |
203
+
| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')`|`map(string)`|`{}`| no |
197
204
| user\_data | Instance user data. Do not pass gzip-compressed data via this argument |`string`|`""`| no |
198
205
| vpc\_id | The ID of the VPC that the instance security group belongs to |`string`| n/a | yes |
199
206
| welcome\_message | Welcome message |`string`|`""`| no |
@@ -217,6 +224,7 @@ Available targets:
217
224
| security\_group\_ids | IDs on the AWS Security Groups associated with the instance |
218
225
| ssh\_key\_pair | Name of the SSH key pair provisioned on the instance |
0 commit comments