Skip to content

Commit 6b0ab4e

Browse files
joe-nilandactions-bot
joe-niland
and
actions-bot
authored
Change fixtures to use us-east-2 (#64)
Co-authored-by: actions-bot <58130806+actions-bot@users.noreply.github.com>
1 parent 3a58a3d commit 6b0ab4e

File tree

4 files changed

+155
-125
lines changed

4 files changed

+155
-125
lines changed

‎README.md‎

Lines changed: 74 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -146,77 +146,92 @@ Available targets:
146146
lint Lint terraform code
147147
148148
```
149+
## Requirements
150+
151+
| Name | Version |
152+
|------|---------|
153+
| terraform | ~> 0.12.0 |
154+
| aws | ~> 2.0 |
155+
| null | ~> 2.0 |
156+
157+
## Providers
158+
159+
| Name | Version |
160+
|------|---------|
161+
| aws | ~> 2.0 |
162+
| null | ~> 2.0 |
163+
149164
## Inputs
150165

151166
| Name | Description | Type | Default | Required |
152-
|------|-------------|:----:|:-----:|:-----:|
153-
| additional_ips_count | Count of additional EIPs | number | `0` | no |
154-
| allowed_ports | List of allowed ingress ports | list(number) | `<list>` | no |
155-
| ami | The AMI to use for the instance. By default it is the AMI provided by Amazon with Ubuntu 16.04 | string | `` | no |
156-
| ami_owner | Owner of the given AMI (ignored if `ami` unset) | string | `` | no |
157-
| applying_period | The period in seconds over which the specified statistic is applied | number | `60` | no |
158-
| assign_eip_address | Assign an Elastic IP address to the instance | bool | `true` | no |
159-
| associate_public_ip_address | Associate a public IP address with the instance | bool | `true` | no |
160-
| attributes | Additional attributes (e.g. `1`) | list(string) | `<list>` | no |
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 |
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-
| create_default_security_group | Create default Security Group with only Egress traffic allowed | bool | `true` | no |
164-
| default_alarm_action | Default alerm action | string | `action/actions/AWS_EC2.InstanceId.Reboot/1.0` | no |
165-
| delete_on_termination | Whether the volume should be destroyed on instance termination | bool | `true` | no |
166-
| delimiter | Delimiter to be used between `name`, `namespace`, `stage`, etc. | string | `-` | no |
167-
| disable_api_termination | Enable EC2 Instance Termination Protection | bool | `false` | no |
168-
| ebs_device_name | Name of the EBS device to mount | list(string) | `<list>` | no |
169-
| ebs_iops | Amount of provisioned IOPS. This must be set with a volume_type of io1 | number | `0` | no |
170-
| ebs_optimized | Launched EC2 instance will be EBS-optimized | bool | `false` | no |
171-
| ebs_volume_count | Count of EBS volumes that will be attached to the instance | number | `0` | no |
172-
| ebs_volume_size | Size of the EBS volume in gigabytes | number | `10` | no |
173-
| ebs_volume_type | The type of EBS volume. Can be standard, gp2 or io1 | string | `gp2` | no |
174-
| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no |
175-
| evaluation_periods | The number of periods over which data is compared to the specified threshold. | number | `5` | no |
176-
| instance_enabled | Flag to control the instance creation. Set to false if it is necessary to skip instance creation | bool | `true` | no |
177-
| instance_type | The type of the instance | string | `t2.micro` | no |
178-
| 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 |
179-
| ipv6_addresses | List of IPv6 addresses from the range of the subnet to associate with the primary network interface | list(string) | `<list>` | no |
180-
| 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 |
181-
| 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 |
182-
| metric_threshold | The value against which the specified statistic is compared | number | `1` | no |
183-
| monitoring | Launched EC2 instance will have detailed monitoring enabled | bool | `true` | no |
184-
| name | Name (e.g. `bastion` or `db`) | string | - | yes |
185-
| namespace | Namespace (e.g. `cp` or `cloudposse`) | string | `` | no |
186-
| permissions_boundary_arn | Policy ARN to attach to instance role as a permissions boundary | string | `` | no |
187-
| private_ip | Private IP address to associate with the instance in the VPC | string | `` | no |
188-
| region | AWS Region the instance is launched in | string | `` | no |
189-
| root_iops | Amount of provisioned IOPS. This must be set if root_volume_type is set to `io1` | number | `0` | no |
190-
| root_volume_size | Size of the root volume in gigabytes | number | `10` | no |
191-
| root_volume_type | Type of root volume. Can be standard, gp2 or io1 | string | `gp2` | no |
192-
| security_groups | List of Security Group IDs allowed to connect to the instance | list(string) | `<list>` | no |
193-
| 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 |
194-
| ssh_key_pair | SSH key pair to be provisioned on the instance | string | - | yes |
195-
| stage | Stage (e.g. `prod`, `dev`, `staging` | string | `` | no |
196-
| statistic_level | The statistic to apply to the alarm's associated metric. Allowed values are: SampleCount, Average, Sum, Minimum, Maximum | string | `Maximum` | no |
197-
| subnet | VPC Subnet ID the instance is launched in | string | - | yes |
198-
| tags | Additional tags | map(string) | `<map>` | no |
199-
| user_data | Instance user data. Do not pass gzip-compressed data via this argument | string | `` | no |
200-
| vpc_id | The ID of the VPC that the instance security group belongs to | string | - | yes |
201-
| welcome_message | Welcome message | string | `` | no |
167+
|------|-------------|------|---------|:--------:|
168+
| additional\_ips\_count | Count of additional EIPs | `number` | `0` | no |
169+
| allowed\_ports | List of allowed ingress ports | `list(number)` | `[]` | no |
170+
| ami | The AMI to use for the instance. By default it is the AMI provided by Amazon with Ubuntu 16.04 | `string` | `""` | no |
171+
| ami\_owner | Owner of the given AMI (ignored if `ami` unset) | `string` | `""` | no |
172+
| applying\_period | The period in seconds over which the specified statistic is applied | `number` | `60` | no |
173+
| assign\_eip\_address | Assign an Elastic IP address to the instance | `bool` | `true` | no |
174+
| associate\_public\_ip\_address | Associate a public IP address with the instance | `bool` | `true` | no |
175+
| attributes | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no |
176+
| availability\_zone | Availability Zone the instance is launched in. If not set, will be launched in the first AZ of the region | `string` | `""` | no |
177+
| comparison\_operator | The arithmetic operation to use when comparing the specified Statistic and Threshold. Possible values are: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold. | `string` | `"GreaterThanOrEqualToThreshold"` | no |
178+
| create\_default\_security\_group | Create default Security Group with only Egress traffic allowed | `bool` | `true` | no |
179+
| default\_alarm\_action | Default alerm action | `string` | `"action/actions/AWS_EC2.InstanceId.Reboot/1.0"` | no |
180+
| delete\_on\_termination | Whether the volume should be destroyed on instance termination | `bool` | `true` | no |
181+
| delimiter | Delimiter to be used between `name`, `namespace`, `stage`, etc. | `string` | `"-"` | no |
182+
| disable\_api\_termination | Enable EC2 Instance Termination Protection | `bool` | `false` | no |
183+
| 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 |
184+
| ebs\_iops | Amount of provisioned IOPS. This must be set with a volume\_type of io1 | `number` | `0` | no |
185+
| ebs\_optimized | Launched EC2 instance will be EBS-optimized | `bool` | `false` | no |
186+
| ebs\_volume\_count | Count of EBS volumes that will be attached to the instance | `number` | `0` | no |
187+
| ebs\_volume\_size | Size of the EBS volume in gigabytes | `number` | `10` | no |
188+
| ebs\_volume\_type | The type of EBS volume. Can be standard, gp2 or io1 | `string` | `"gp2"` | no |
189+
| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | `string` | `""` | no |
190+
| evaluation\_periods | The number of periods over which data is compared to the specified threshold. | `number` | `5` | no |
191+
| instance\_enabled | Flag to control the instance creation. Set to false if it is necessary to skip instance creation | `bool` | `true` | no |
192+
| instance\_type | The type of the instance | `string` | `"t2.micro"` | no |
193+
| 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 |
194+
| ipv6\_addresses | List of IPv6 addresses from the range of the subnet to associate with the primary network interface | `list(string)` | `[]` | no |
195+
| 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 |
196+
| 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 |
197+
| metric\_threshold | The value against which the specified statistic is compared | `number` | `1` | no |
198+
| monitoring | Launched EC2 instance will have detailed monitoring enabled | `bool` | `true` | no |
199+
| name | Name (e.g. `bastion` or `db`) | `string` | n/a | yes |
200+
| namespace | Namespace (e.g. `cp` or `cloudposse`) | `string` | `""` | no |
201+
| permissions\_boundary\_arn | Policy ARN to attach to instance role as a permissions boundary | `string` | `""` | no |
202+
| private\_ip | Private IP address to associate with the instance in the VPC | `string` | `""` | no |
203+
| region | AWS Region the instance is launched in | `string` | `""` | no |
204+
| root\_iops | Amount of provisioned IOPS. This must be set if root\_volume\_type is set to `io1` | `number` | `0` | no |
205+
| root\_volume\_size | Size of the root volume in gigabytes | `number` | `10` | no |
206+
| root\_volume\_type | Type of root volume. Can be standard, gp2 or io1 | `string` | `"gp2"` | no |
207+
| security\_groups | List of Security Group IDs allowed to connect to the instance | `list(string)` | `[]` | no |
208+
| 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 |
209+
| ssh\_key\_pair | SSH key pair to be provisioned on the instance | `string` | n/a | yes |
210+
| stage | Stage (e.g. `prod`, `dev`, `staging` | `string` | `""` | no |
211+
| statistic\_level | The statistic to apply to the alarm's associated metric. Allowed values are: SampleCount, Average, Sum, Minimum, Maximum | `string` | `"Maximum"` | no |
212+
| subnet | VPC Subnet ID the instance is launched in | `string` | n/a | yes |
213+
| tags | Additional tags | `map(string)` | `{}` | no |
214+
| user\_data | Instance user data. Do not pass gzip-compressed data via this argument | `string` | `""` | no |
215+
| vpc\_id | The ID of the VPC that the instance security group belongs to | `string` | n/a | yes |
216+
| welcome\_message | Welcome message | `string` | `""` | no |
202217

203218
## Outputs
204219

205220
| Name | Description |
206221
|------|-------------|
207-
| additional_eni_ids | Map of ENI to EIP |
222+
| additional\_eni\_ids | Map of ENI to EIP |
208223
| alarm | CloudWatch Alarm ID |
209-
| ebs_ids | IDs of EBSs |
224+
| ebs\_ids | IDs of EBSs |
210225
| id | Disambiguated ID of the instance |
211226
| name | Instance name |
212-
| primary_network_interface_id | ID of the instance's primary network interface |
213-
| private_dns | Private DNS of instance |
214-
| private_ip | Private IP of instance |
215-
| public_dns | Public DNS of instance (or DNS of EIP) |
216-
| public_ip | Public IP of instance (or EIP) |
227+
| primary\_network\_interface\_id | ID of the instance's primary network interface |
228+
| private\_dns | Private DNS of instance |
229+
| private\_ip | Private IP of instance |
230+
| public\_dns | Public DNS of instance (or DNS of EIP) |
231+
| public\_ip | Public IP of instance (or EIP) |
217232
| role | Name of AWS IAM Role associated with the instance |
218-
| security_group_ids | IDs on the AWS Security Groups associated with the instance |
219-
| ssh_key_pair | Name of the SSH key pair provisioned on the instance |
233+
| security\_group\_ids | IDs on the AWS Security Groups associated with the instance |
234+
| ssh\_key\_pair | Name of the SSH key pair provisioned on the instance |
220235

221236

222237

0 commit comments

Comments
 (0)