|
2 | 2 |
|
3 | 3 | | Name | Description | Type | Default | Required | |
4 | 4 | |------|-------------|:----:|:-----:|:-----:| |
5 | | -| additional_ips_count | Count of additional EIPs | string | `0` | no | |
6 | | -| allowed_ports | List of allowed ingress ports | list | `<list>` | no | |
7 | | -| ami | The AMI to use for the instance. | string | - | yes | |
| 5 | +| additional_ips_count | Count of additional EIPs | number | `0` | no | |
| 6 | +| allowed_ports | List of allowed ingress ports | list(number) | `<list>` | no | |
| 7 | +| ami | The AMI to use for the instance | string | - | yes | |
8 | 8 | | ami_owner | Owner of the given AMI | string | - | yes | |
9 | | -| applying_period | The period in seconds over which the specified statistic is applied | string | `60` | no | |
10 | | -| assign_eip_address | Assign an Elastic IP address to the instance | string | `true` | no | |
11 | | -| associate_public_ip_address | Associate a public IP address with the instance | string | `true` | no | |
12 | | -| attributes | Additional attributes (e.g. `policy` or `role`) | list | `<list>` | no | |
| 9 | +| applying_period | The period in seconds over which the specified statistic is applied | number | `60` | no | |
| 10 | +| assign_eip_address | Assign an Elastic IP address to the instance | bool | `true` | no | |
| 11 | +| associate_public_ip_address | Associate a public IP address with the instance | bool | `true` | no | |
| 12 | +| attributes | Additional attributes (_e.g._ "1") | list(string) | `<list>` | no | |
13 | 13 | | availability_zone | Availability Zone the instance is launched in. If not set, will be launched in the first AZ of the region | string | `` | no | |
14 | | -| comparison_operator | The arithmetic operation to use when comparing the specified Statistic and Threshold. Possible values are: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold. | string | `GreaterThanOrEqualToThreshold` | no | |
15 | | -| create_default_security_group | Create default Security Group with only Egress traffic allowed | string | `true` | no | |
16 | | -| default_alarm_action | - | string | `action/actions/AWS_EC2.InstanceId.Reboot/1.0` | no | |
17 | | -| delete_on_termination | Whether the volume should be destroyed on instance termination | string | `true` | no | |
18 | | -| delimiter | - | string | `-` | no | |
19 | | -| disable_api_termination | Enable EC2 Instance Termination Protection | string | `false` | no | |
20 | | -| ebs_device_names | Name of the EBS device to mount | list | `<list>` | no | |
21 | | -| ebs_iops | Amount of provisioned IOPS. This must be set with a volume_type of io1 | string | `0` | no | |
22 | | -| ebs_optimized | Launched EC2 instance will be EBS-optimized | string | `false` | no | |
23 | | -| ebs_volume_count | Count of EBS volumes that will be attached to the instance | string | `0` | no | |
24 | | -| ebs_volume_size | Size of the EBS volume in gigabytes | string | `10` | no | |
| 14 | +| comparison_operator | The arithmetic operation to use when comparing the specified Statistic and Threshold. Possible values are: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold | string | `GreaterThanOrEqualToThreshold` | no | |
| 15 | +| create_default_security_group | Create default Security Group with only Egress traffic allowed | bool | `true` | no | |
| 16 | +| default_alarm_action | Default alarm action | string | `action/actions/AWS_EC2.InstanceId.Reboot/1.0` | no | |
| 17 | +| delete_on_termination | Whether the volume should be destroyed on instance termination | bool | `true` | no | |
| 18 | +| delimiter | Delimiter between `namespace`, `stage`, `name` and `attributes` | string | `-` | no | |
| 19 | +| disable_api_termination | Enable EC2 Instance Termination Protection | bool | `false` | no | |
| 20 | +| ebs_device_names | Name of the EBS device to mount | list(string) | `<list>` | no | |
| 21 | +| ebs_iops | Amount of provisioned IOPS. This must be set with a volume_type of io1 | number | `0` | no | |
| 22 | +| ebs_optimized | Launched EC2 instance will be EBS-optimized | bool | `false` | no | |
| 23 | +| ebs_volume_count | Count of EBS volumes that will be attached to the instance | number | `0` | no | |
| 24 | +| ebs_volume_size | Size of the EBS volume in gigabytes | number | `10` | no | |
25 | 25 | | ebs_volume_type | The type of EBS volume. Can be standard, gp2 or io1 | string | `gp2` | no | |
26 | | -| evaluation_periods | The number of periods over which data is compared to the specified threshold. | string | `5` | no | |
27 | | -| generate_ssh_key_pair | If true, create a new key pair and save the pem for it to the current working directory | string | `false` | no | |
28 | | -| instance_count | Count of ec2 instances to create | string | `1` | no | |
29 | | -| instance_enabled | Flag to control the instance creation. Set to false if it is necessary to skip instance creation | string | `true` | no | |
| 26 | +| evaluation_periods | The number of periods over which data is compared to the specified threshold | number | `5` | no | |
| 27 | +| generate_ssh_key_pair | If true, create a new key pair and save the pem for it to the current working directory | bool | `false` | no | |
| 28 | +| instance_count | Count of ec2 instances to create | number | `1` | no | |
| 29 | +| instance_enabled | Flag to control the instance creation. Set to false if it is necessary to skip instance creation | bool | `true` | no | |
30 | 30 | | instance_type | The type of the instance | string | `t2.micro` | no | |
31 | | -| 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 | string | `0` | no | |
32 | | -| ipv6_addresses | List of IPv6 addresses from the range of the subnet to associate with the primary network interface | list | `<list>` | no | |
| 31 | +| 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 | number | `0` | no | |
| 32 | +| ipv6_addresses | List of IPv6 addresses from the range of the subnet to associate with the primary network interface | list(string) | `<list>` | no | |
33 | 33 | | 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 | |
34 | 34 | | 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 | |
35 | | -| metric_threshold | The value against which the specified statistic is compared | string | `1` | no | |
36 | | -| monitoring | Launched EC2 instance will have detailed monitoring enabled | string | `true` | no | |
37 | | -| name | Name (e.g. `bastion` or `db`) - required for `terraform-terraform-label` module | string | - | yes | |
38 | | -| namespace | Namespace (e.g. `cp` or `cloudposse`) - required for `terraform-terraform-label` module | string | - | yes | |
39 | | -| private_ips | Private IP address to associate with the instances in the VPC | list | `<list>` | no | |
40 | | -| region | AWS Region the instance is launched in | string | `` | no | |
41 | | -| root_iops | Amount of provisioned IOPS. This must be set if root_volume_type is set to `io1` | string | `0` | no | |
42 | | -| root_volume_size | Size of the root volume in gigabytes | string | `10` | no | |
| 35 | +| metric_threshold | The value against which the specified statistic is compared | number | `1` | no | |
| 36 | +| monitoring | Launched EC2 instance will have detailed monitoring enabled | bool | `true` | no | |
| 37 | +| name | Name of the application | string | - | yes | |
| 38 | +| namespace | Namespace (e.g. `eg` or `cp`) | string | `` | no | |
| 39 | +| private_ips | Private IP address to associate with the instances in the VPC | list(string) | `<list>` | no | |
| 40 | +| region | AWS Region the instance is launched in | string | - | yes | |
| 41 | +| root_iops | Amount of provisioned IOPS. This must be set if root_volume_type is set to `io1` | number | `0` | no | |
| 42 | +| root_volume_size | Size of the root volume in gigabytes | number | `10` | no | |
43 | 43 | | root_volume_type | Type of root volume. Can be standard, gp2 or io1 | string | `gp2` | no | |
44 | | -| security_groups | List of Security Group IDs allowed to connect to the instance | list | `<list>` | no | |
45 | | -| 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 | string | `true` | no | |
| 44 | +| security_groups | List of Security Group IDs allowed to connect to the instance | list(string) | `<list>` | no | |
| 45 | +| 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 | |
46 | 46 | | ssh_key_pair | SSH key pair to be provisioned on the instance | string | `` | no | |
47 | | -| ssh_key_pair_path | Path to where the generated key pairs will be created. Defaults to $${path.cwd} | string | `` | no | |
48 | | -| stage | Stage (e.g. `prod`, `dev`, `staging` - required for `terraform-terraform-label` module | string | - | yes | |
| 47 | +| ssh_key_pair_path | Path to where the generated key pairs will be created. Defaults to $$${path.cwd} | string | `` | no | |
| 48 | +| stage | Stage (e.g. `prod`, `dev`, `staging`) | string | `` | no | |
49 | 49 | | statistic_level | The statistic to apply to the alarm's associated metric. Allowed values are: SampleCount, Average, Sum, Minimum, Maximum | string | `Maximum` | no | |
50 | 50 | | subnet | VPC Subnet ID the instance is launched in | string | - | yes | |
51 | | -| tags | Additional tags | map | `<map>` | no | |
| 51 | +| tags | Additional tags (_e.g._ { BusinessUnit : ABC }) | map(string) | `<map>` | no | |
52 | 52 | | user_data | Instance user data. Do not pass gzip-compressed data via this argument | string | `` | no | |
53 | 53 | | vpc_id | The ID of the VPC that the instance security group belongs to | string | - | yes | |
54 | | -| welcome_message | - | string | `` | no | |
| 54 | +| welcome_message | Welcome message | string | `` | no | |
55 | 55 |
|
56 | 56 | ## Outputs |
57 | 57 |
|
|
63 | 63 | | eip_per_instance_count | Number of EIPs per instance. | |
64 | 64 | | eni_to_eip_map | Map of ENI with EIP | |
65 | 65 | | ids | Disambiguated IDs list | |
66 | | -| instance_count | Total number of instances created. | |
| 66 | +| instance_count | Total number of instances created | |
67 | 67 | | network_interface_ids | IDs of the network interface that was created with the instance | |
68 | 68 | | new_ssh_keypair_generated | Was a new ssh_key_pair generated | |
69 | 69 | | primary_network_interface_ids | IDs of the instance's primary network interface | |
|
0 commit comments