Skip to content

Commit 5e0a7c8

Browse files
antonbabenkoantonbabenko
committed
Updated README
1 parent 151b96c commit 5e0a7c8

File tree

4 files changed

+71
-37
lines changed

4 files changed

+71
-37
lines changed

‎.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
repos:
22
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.27.0
3+
rev: v1.31.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_docs
77
- repo: git://github.com/pre-commit/pre-commit-hooks
8-
rev: v2.5.0
8+
rev: v3.1.0
99
hooks:
1010
- id: check-merge-conflict

‎README.md

Lines changed: 43 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -92,42 +92,52 @@ data "aws_ami" "ubuntu-xenial" {
9292
* One of `subnet_id` or `subnet_ids` is required. If both are provided, the value of `subnet_id` is prepended to the value of `subnet_ids`.
9393

9494
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
95+
## Requirements
96+
97+
No requirements.
98+
99+
## Providers
100+
101+
| Name | Version |
102+
|------|---------|
103+
| aws | n/a |
104+
95105
## Inputs
96106

97107
| Name | Description | Type | Default | Required |
98-
|------|-------------|:----:|:-----:|:-----:|
99-
| ami | ID of AMI to use for the instance | string | n/a | yes |
100-
| associate\_public\_ip\_address | If true, the EC2 instance will have associated public IP address | bool | `"null"` | no |
101-
| cpu\_credits | The credit option for CPU usage (unlimited or standard) | string | `"standard"` | no |
102-
| disable\_api\_termination | If true, enables EC2 Instance Termination Protection | bool | `"false"` | no |
103-
| ebs\_block\_device | Additional EBS block devices to attach to the instance | list(map(string)) | `[]` | no |
104-
| ebs\_optimized | If true, the launched EC2 instance will be EBS-optimized | bool | `"false"` | no |
105-
| ephemeral\_block\_device | Customize Ephemeral (also known as Instance Store) volumes on the instance | list(map(string)) | `[]` | no |
106-
| get\_password\_data | If true, wait for password data to become available and retrieve it. | bool | `"false"` | no |
107-
| iam\_instance\_profile | The IAM Instance Profile to launch the instance with. Specified as the name of the Instance Profile. | string | `""` | no |
108-
| instance\_count | Number of instances to launch | number | `"1"` | no |
109-
| instance\_initiated\_shutdown\_behavior | Shutdown behavior for the instance | string | `""` | no |
110-
| instance\_type | The type of instance to start | string | n/a | yes |
111-
| ipv6\_address\_count | A number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. | number | `"null"` | no |
112-
| ipv6\_addresses | Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface | list(string) | `"null"` | no |
113-
| key\_name | The key name to use for the instance | string | `""` | no |
114-
| monitoring | If true, the launched EC2 instance will have detailed monitoring enabled | bool | `"false"` | no |
115-
| name | Name to be used on all resources as prefix | string | n/a | yes |
116-
| network\_interface | Customize network interfaces to be attached at instance boot time | list(map(string)) | `[]` | no |
117-
| placement\_group | The Placement Group to start the instance in | string | `""` | no |
118-
| private\_ip | Private IP address to associate with the instance in a VPC | string | `"null"` | no |
119-
| private\_ips | A list of private IP address to associate with the instance in a VPC. Should match the number of instances. | list(string) | `[]` | no |
120-
| root\_block\_device | Customize details about the root block device of the instance. See Block Devices below for details | list(map(string)) | `[]` | no |
121-
| 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 |
122-
| subnet\_id | The VPC Subnet ID to launch in | string | `""` | no |
123-
| subnet\_ids | A list of VPC Subnet IDs to launch in | list(string) | `[]` | no |
124-
| tags | A mapping of tags to assign to the resource | map(string) | `{}` | no |
125-
| tenancy | The tenancy of the instance (if the instance is running in a VPC). Available values: default, dedicated, host. | string | `"default"` | no |
126-
| use\_num\_suffix | Always append numerical suffix to instance name, even if instance_count is 1 | bool | `"false"` | no |
127-
| user\_data | The user data to provide when launching the instance. Do not pass gzip-compressed data via this argument; see user_data_base64 instead. | string | `"null"` | no |
128-
| user\_data\_base64 | Can be used instead of user_data to pass base64-encoded binary data directly. Use this instead of user_data whenever the value is not a valid UTF-8 string. For example, gzip-encoded user data must be base64-encoded and passed via this argument to avoid corruption. | string | `"null"` | no |
129-
| volume\_tags | A mapping of tags to assign to the devices created by the instance at launch time | map(string) | `{}` | no |
130-
| vpc\_security\_group\_ids | A list of security group IDs to associate with | list(string) | `"null"` | no |
108+
|------|-------------|------|---------|:--------:|
109+
| ami | ID of AMI to use for the instance | `string` | n/a | yes |
110+
| associate\_public\_ip\_address | If true, the EC2 instance will have associated public IP address | `bool` | `null` | no |
111+
| cpu\_credits | The credit option for CPU usage (unlimited or standard) | `string` | `"standard"` | no |
112+
| disable\_api\_termination | If true, enables EC2 Instance Termination Protection | `bool` | `false` | no |
113+
| ebs\_block\_device | Additional EBS block devices to attach to the instance | `list(map(string))` | `[]` | no |
114+
| ebs\_optimized | If true, the launched EC2 instance will be EBS-optimized | `bool` | `false` | no |
115+
| ephemeral\_block\_device | Customize Ephemeral (also known as Instance Store) volumes on the instance | `list(map(string))` | `[]` | no |
116+
| get\_password\_data | If true, wait for password data to become available and retrieve it. | `bool` | `false` | no |
117+
| iam\_instance\_profile | The IAM Instance Profile to launch the instance with. Specified as the name of the Instance Profile. | `string` | `""` | no |
118+
| instance\_count | Number of instances to launch | `number` | `1` | no |
119+
| instance\_initiated\_shutdown\_behavior | Shutdown behavior for the instance | `string` | `""` | no |
120+
| instance\_type | The type of instance to start | `string` | n/a | yes |
121+
| ipv6\_address\_count | A number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. | `number` | `null` | no |
122+
| ipv6\_addresses | Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface | `list(string)` | `null` | no |
123+
| key\_name | The key name to use for the instance | `string` | `""` | no |
124+
| monitoring | If true, the launched EC2 instance will have detailed monitoring enabled | `bool` | `false` | no |
125+
| name | Name to be used on all resources as prefix | `string` | n/a | yes |
126+
| network\_interface | Customize network interfaces to be attached at instance boot time | `list(map(string))` | `[]` | no |
127+
| placement\_group | The Placement Group to start the instance in | `string` | `""` | no |
128+
| private\_ip | Private IP address to associate with the instance in a VPC | `string` | `null` | no |
129+
| private\_ips | A list of private IP address to associate with the instance in a VPC. Should match the number of instances. | `list(string)` | `[]` | no |
130+
| root\_block\_device | Customize details about the root block device of the instance. See Block Devices below for details | `list(map(string))` | `[]` | no |
131+
| 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 |
132+
| subnet\_id | The VPC Subnet ID to launch in | `string` | `""` | no |
133+
| subnet\_ids | A list of VPC Subnet IDs to launch in | `list(string)` | `[]` | no |
134+
| tags | A mapping of tags to assign to the resource | `map(string)` | `{}` | no |
135+
| tenancy | The tenancy of the instance (if the instance is running in a VPC). Available values: default, dedicated, host. | `string` | `"default"` | no |
136+
| use\_num\_suffix | Always append numerical suffix to instance name, even if instance\_count is 1 | `bool` | `false` | no |
137+
| user\_data | The user data to provide when launching the instance. Do not pass gzip-compressed data via this argument; see user\_data\_base64 instead. | `string` | `null` | no |
138+
| user\_data\_base64 | Can be used instead of user\_data to pass base64-encoded binary data directly. Use this instead of user\_data whenever the value is not a valid UTF-8 string. For example, gzip-encoded user data must be base64-encoded and passed via this argument to avoid corruption. | `string` | `null` | no |
139+
| volume\_tags | A mapping of tags to assign to the devices created by the instance at launch time | `map(string)` | `{}` | no |
140+
| vpc\_security\_group\_ids | A list of security group IDs to associate with | `list(string)` | `null` | no |
131141

132142
## Outputs
133143

‎examples/basic/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,20 @@ $ terraform apply
1515
Note that this example may create resources which can cost money. Run `terraform destroy` when you don't need these resources.
1616

1717
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Requirements
19+
20+
No requirements.
21+
22+
## Providers
23+
24+
| Name | Version |
25+
|------|---------|
26+
| aws | n/a |
27+
28+
## Inputs
29+
30+
No input.
31+
1832
## Outputs
1933

2034
| Name | Description |

‎examples/volume-attachment/README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,21 @@ $ terraform apply
1919
Note that this example may create resources which can cost money. Run `terraform destroy` when you don't need these resources.
2020

2121
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
22+
## Requirements
23+
24+
No requirements.
25+
26+
## Providers
27+
28+
| Name | Version |
29+
|------|---------|
30+
| aws | n/a |
31+
2232
## Inputs
2333

2434
| Name | Description | Type | Default | Required |
25-
|------|-------------|:----:|:-----:|:-----:|
26-
| instances\_number | | string | `"1"` | no |
35+
|------|-------------|------|---------|:--------:|
36+
| instances\_number | n/a | `number` | `1` | no |
2737

2838
## Outputs
2939

0 commit comments

Comments
 (0)