Skip to content

T
terraform-aws-vpc
Commit 57604d2e authored by Anton Babenko's avatar Anton Babenko
Browse files
Options

Updated pre-commit version with new terraform-docs script

parent 7c29b247
Show whitespace changes
Inline Side-by-side
Showing with 167 additions and 177 deletions
.pre-commit-config.yaml
View file @ 57604d2e
repos: repos:
- repo: git://github.com/antonbabenko/pre-commit-terraform - repo: git://github.com/antonbabenko/pre-commit-terraform
rev: v1.7.2 rev: v1.7.4
hooks: hooks:
- id: terraform_fmt - id: terraform_fmt
- id: terraform_docs - id: terraform_docs
- repo: git://github.com/pre-commit/pre-commit-hooks - repo: git://github.com/pre-commit/pre-commit-hooks
rev: v1.2.3 rev: v2.0.0
hooks: hooks:
- id: check-merge-conflict - id: check-merge-conflict
README.md
View file @ 57604d2e
...@@ -162,136 +162,135 @@ Terraform version 0.10.3 or newer is required for this module to work. ...@@ -162,136 +162,135 @@ Terraform version 0.10.3 or newer is required for this module to work.
* Few tests and edge cases examples: [#46](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/issue-46-no-private-subnets), [#44](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/issue-44-asymmetric-private-subnets), [#108](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/issue-108-route-already-exists) * Few tests and edge cases examples: [#46](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/issue-46-no-private-subnets), [#44](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/issue-44-asymmetric-private-subnets), [#108](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/issue-108-route-already-exists)
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Inputs ## Inputs
| Name | Description | Type | Default | Required | | Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:| |------|-------------|:----:|:-----:|:-----:|
| amazon_side_asn | The Autonomous System Number (ASN) for the Amazon side of the gateway. By default the virtual private gateway is created with the current default Amazon ASN. | string | `64512` | no | | amazon\_side\_asn | The Autonomous System Number (ASN) for the Amazon side of the gateway. By default the virtual private gateway is created with the current default Amazon ASN. | string | `64512` | no |
| assign_generated_ipv6_cidr_block | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block | string | `false` | no | | assign\_generated\_ipv6\_cidr\_block | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block | string | `false` | no |
| azs | A list of availability zones in the region | string | `<list>` | no | | azs | A list of availability zones in the region | list | `[]` | no |
| cidr | The CIDR block for the VPC. Default value is a valid CIDR, but not acceptable by AWS and should be overridden | string | `0.0.0.0/0` | no | | cidr | The CIDR block for the VPC. Default value is a valid CIDR, but not acceptable by AWS and should be overridden | string | `0.0.0.0/0` | no |
| create_database_subnet_group | Controls if database subnet group should be created | string | `true` | no | | create\_database\_subnet\_group | Controls if database subnet group should be created | string | `true` | no |
| create_database_subnet_route_table | Controls if separate route table for database should be created | string | `false` | no | | create\_database\_subnet\_route\_table | Controls if separate route table for database should be created | string | `false` | no |
| create_elasticache_subnet_route_table | Controls if separate route table for elasticache should be created | string | `false` | no | | create\_elasticache\_subnet\_route\_table | Controls if separate route table for elasticache should be created | string | `false` | no |
| create_redshift_subnet_route_table | Controls if separate route table for redshift should be created | string | `false` | no | | create\_redshift\_subnet\_route\_table | Controls if separate route table for redshift should be created | string | `false` | no |
| create_vpc | Controls if VPC should be created (it affects almost all resources) | string | `true` | no | | create\_vpc | Controls if VPC should be created (it affects almost all resources) | string | `true` | no |
| database_route_table_tags | Additional tags for the database route tables | string | `<map>` | no | | database\_route\_table\_tags | Additional tags for the database route tables | map | `{}` | no |
| database_subnet_group_tags | Additional tags for the database subnet group | string | `<map>` | no | | database\_subnet\_group\_tags | Additional tags for the database subnet group | map | `{}` | no |
| database_subnet_suffix | Suffix to append to database subnets name | string | `db` | no | | database\_subnet\_suffix | Suffix to append to database subnets name | string | `db` | no |
| database_subnet_tags | Additional tags for the database subnets | string | `<map>` | no | | database\_subnet\_tags | Additional tags for the database subnets | map | `{}` | no |
| database_subnets | A list of database subnets | list | `<list>` | no | | database\_subnets | A list of database subnets | list | `[]` | no |
| default_vpc_enable_classiclink | Should be true to enable ClassicLink in the Default VPC | string | `false` | no | | default\_vpc\_enable\_classiclink | Should be true to enable ClassicLink in the Default VPC | string | `false` | no |
| default_vpc_enable_dns_hostnames | Should be true to enable DNS hostnames in the Default VPC | string | `false` | no | | default\_vpc\_enable\_dns\_hostnames | Should be true to enable DNS hostnames in the Default VPC | string | `false` | no |
| default_vpc_enable_dns_support | Should be true to enable DNS support in the Default VPC | string | `true` | no | | default\_vpc\_enable\_dns\_support | Should be true to enable DNS support in the Default VPC | string | `true` | no |
| default_vpc_name | Name to be used on the Default VPC | string | `` | no | | default\_vpc\_name | Name to be used on the Default VPC | string | `` | no |
| default_vpc_tags | Additional tags for the Default VPC | string | `<map>` | no | | default\_vpc\_tags | Additional tags for the Default VPC | map | `{}` | no |
| dhcp_options_domain_name | Specifies DNS name for DHCP options set | string | `` | no | | dhcp\_options\_domain\_name | Specifies DNS name for DHCP options set | string | `` | no |
| dhcp_options_domain_name_servers | Specify a list of DNS server addresses for DHCP options set, default to AWS provided | list | `<list>` | no | | dhcp\_options\_domain\_name\_servers | Specify a list of DNS server addresses for DHCP options set, default to AWS provided | list | `[ "AmazonProvidedDNS" ]` | no |
| dhcp_options_netbios_name_servers | Specify a list of netbios servers for DHCP options set | list | `<list>` | no | | dhcp\_options\_netbios\_name\_servers | Specify a list of netbios servers for DHCP options set | list | `[]` | no |
| dhcp_options_netbios_node_type | Specify netbios node_type for DHCP options set | string | `` | no | | dhcp\_options\_netbios\_node\_type | Specify netbios node_type for DHCP options set | string | `` | no |
| dhcp_options_ntp_servers | Specify a list of NTP servers for DHCP options set | list | `<list>` | no | | dhcp\_options\_ntp\_servers | Specify a list of NTP servers for DHCP options set | list | `[]` | no |
| dhcp_options_tags | Additional tags for the DHCP option set | string | `<map>` | no | | dhcp\_options\_tags | Additional tags for the DHCP option set | map | `{}` | no |
| elasticache_route_table_tags | Additional tags for the elasticache route tables | string | `<map>` | no | | elasticache\_route\_table\_tags | Additional tags for the elasticache route tables | map | `{}` | no |
| elasticache_subnet_suffix | Suffix to append to elasticache subnets name | string | `elasticache` | no | | elasticache\_subnet\_suffix | Suffix to append to elasticache subnets name | string | `elasticache` | no |
| elasticache_subnet_tags | Additional tags for the elasticache subnets | string | `<map>` | no | | elasticache\_subnet\_tags | Additional tags for the elasticache subnets | map | `{}` | no |
| elasticache_subnets | A list of elasticache subnets | list | `<list>` | no | | elasticache\_subnets | A list of elasticache subnets | list | `[]` | no |
| enable_dhcp_options | Should be true if you want to specify a DHCP options set with a custom domain name, DNS servers, NTP servers, netbios servers, and/or netbios server type | string | `false` | no | | enable\_dhcp\_options | Should be true if you want to specify a DHCP options set with a custom domain name, DNS servers, NTP servers, netbios servers, and/or netbios server type | string | `false` | no |
| enable_dns_hostnames | Should be true to enable DNS hostnames in the VPC | string | `false` | no | | enable\_dns\_hostnames | Should be true to enable DNS hostnames in the VPC | string | `false` | no |
| enable_dns_support | Should be true to enable DNS support in the VPC | string | `true` | no | | enable\_dns\_support | Should be true to enable DNS support in the VPC | string | `true` | no |
| enable_dynamodb_endpoint | Should be true if you want to provision a DynamoDB endpoint to the VPC | string | `false` | no | | enable\_dynamodb\_endpoint | Should be true if you want to provision a DynamoDB endpoint to the VPC | string | `false` | no |
| enable_nat_gateway | Should be true if you want to provision NAT Gateways for each of your private networks | string | `false` | no | | enable\_nat\_gateway | Should be true if you want to provision NAT Gateways for each of your private networks | string | `false` | no |
| enable_s3_endpoint | Should be true if you want to provision an S3 endpoint to the VPC | string | `false` | no | | enable\_s3\_endpoint | Should be true if you want to provision an S3 endpoint to the VPC | string | `false` | no |
| enable_vpn_gateway | Should be true if you want to create a new VPN Gateway resource and attach it to the VPC | string | `false` | no | | enable\_vpn\_gateway | Should be true if you want to create a new VPN Gateway resource and attach it to the VPC | string | `false` | no |
| external_nat_ip_ids | List of EIP IDs to be assigned to the NAT Gateways (used in combination with reuse_nat_ips) | list | `<list>` | no | | external\_nat\_ip\_ids | List of EIP IDs to be assigned to the NAT Gateways (used in combination with reuse_nat_ips) | list | `[]` | no |
| igw_tags | Additional tags for the internet gateway | string | `<map>` | no | | igw\_tags | Additional tags for the internet gateway | map | `{}` | no |
| instance_tenancy | A tenancy option for instances launched into the VPC | string | `default` | no | | instance\_tenancy | A tenancy option for instances launched into the VPC | string | `default` | no |
| intra_route_table_tags | Additional tags for the intra route tables | string | `<map>` | no | | intra\_route\_table\_tags | Additional tags for the intra route tables | map | `{}` | no |
| intra_subnet_tags | Additional tags for the intra subnets | string | `<map>` | no | | intra\_subnet\_tags | Additional tags for the intra subnets | map | `{}` | no |
| intra_subnets | A list of intra subnets | list | `<list>` | no | | intra\_subnets | A list of intra subnets | list | `[]` | no |
| manage_default_vpc | Should be true to adopt and manage Default VPC | string | `false` | no | | manage\_default\_vpc | Should be true to adopt and manage Default VPC | string | `false` | no |
| map_public_ip_on_launch | Should be false if you do not want to auto-assign public IP on launch | string | `true` | no | | map\_public\_ip\_on\_launch | Should be false if you do not want to auto-assign public IP on launch | string | `true` | no |
| name | Name to be used on all the resources as identifier | string | `` | no | | name | Name to be used on all the resources as identifier | string | `` | no |
| nat_eip_tags | Additional tags for the NAT EIP | string | `<map>` | no | | nat\_eip\_tags | Additional tags for the NAT EIP | map | `{}` | no |
| nat_gateway_tags | Additional tags for the NAT gateways | string | `<map>` | no | | nat\_gateway\_tags | Additional tags for the NAT gateways | map | `{}` | no |
| one_nat_gateway_per_az | Should be true if you want only one NAT Gateway per availability zone. Requires `var.azs` to be set, and the number of `public_subnets` created to be greater than or equal to the number of availability zones specified in `var.azs`. | string | `false` | no | | one\_nat\_gateway\_per\_az | Should be true if you want only one NAT Gateway per availability zone. Requires `var.azs` to be set, and the number of `public_subnets` created to be greater than or equal to the number of availability zones specified in `var.azs`. | string | `false` | no |
| private_route_table_tags | Additional tags for the private route tables | string | `<map>` | no | | private\_route\_table\_tags | Additional tags for the private route tables | map | `{}` | no |
| private_subnet_suffix | Suffix to append to private subnets name | string | `private` | no | | private\_subnet\_suffix | Suffix to append to private subnets name | string | `private` | no |
| private_subnet_tags | Additional tags for the private subnets | string | `<map>` | no | | private\_subnet\_tags | Additional tags for the private subnets | map | `{}` | no |
| private_subnets | A list of private subnets inside the VPC | string | `<list>` | no | | private\_subnets | A list of private subnets inside the VPC | list | `[]` | no |
| propagate_private_route_tables_vgw | Should be true if you want route table propagation | string | `false` | no | | propagate\_private\_route\_tables\_vgw | Should be true if you want route table propagation | string | `false` | no |
| propagate_public_route_tables_vgw | Should be true if you want route table propagation | string | `false` | no | | propagate\_public\_route\_tables\_vgw | Should be true if you want route table propagation | string | `false` | no |
| public_route_table_tags | Additional tags for the public route tables | string | `<map>` | no | | public\_route\_table\_tags | Additional tags for the public route tables | map | `{}` | no |
| public_subnet_suffix | Suffix to append to public subnets name | string | `public` | no | | public\_subnet\_suffix | Suffix to append to public subnets name | string | `public` | no |
| public_subnet_tags | Additional tags for the public subnets | string | `<map>` | no | | public\_subnet\_tags | Additional tags for the public subnets | map | `{}` | no |
| public_subnets | A list of public subnets inside the VPC | string | `<list>` | no | | public\_subnets | A list of public subnets inside the VPC | list | `[]` | no |
| redshift_route_table_tags | Additional tags for the redshift route tables | string | `<map>` | no | | redshift\_route\_table\_tags | Additional tags for the redshift route tables | map | `{}` | no |
| redshift_subnet_group_tags | Additional tags for the redshift subnet group | string | `<map>` | no | | redshift\_subnet\_group\_tags | Additional tags for the redshift subnet group | map | `{}` | no |
| redshift_subnet_suffix | Suffix to append to redshift subnets name | string | `redshift` | no | | redshift\_subnet\_suffix | Suffix to append to redshift subnets name | string | `redshift` | no |
| redshift_subnet_tags | Additional tags for the redshift subnets | string | `<map>` | no | | redshift\_subnet\_tags | Additional tags for the redshift subnets | map | `{}` | no |
| redshift_subnets | A list of redshift subnets | list | `<list>` | no | | redshift\_subnets | A list of redshift subnets | list | `[]` | no |
| reuse_nat_ips | Should be true if you don't want EIPs to be created for your NAT Gateways and will instead pass them in via the 'external_nat_ip_ids' variable | string | `false` | no | | reuse\_nat\_ips | Should be true if you don't want EIPs to be created for your NAT Gateways and will instead pass them in via the 'external_nat_ip_ids' variable | string | `false` | no |
| secondary_cidr_blocks | List of secondary CIDR blocks to associate with the VPC to extend the IP Address pool | string | `<list>` | no | | secondary\_cidr\_blocks | List of secondary CIDR blocks to associate with the VPC to extend the IP Address pool | list | `[]` | no |
| single_nat_gateway | Should be true if you want to provision a single shared NAT Gateway across all of your private networks | string | `false` | no | | single\_nat\_gateway | Should be true if you want to provision a single shared NAT Gateway across all of your private networks | string | `false` | no |
| tags | A map of tags to add to all resources | string | `<map>` | no | | tags | A map of tags to add to all resources | map | `{}` | no |
| vpc_tags | Additional tags for the VPC | string | `<map>` | no | | vpc\_tags | Additional tags for the VPC | map | `{}` | no |
| vpn_gateway_id | ID of VPN Gateway to attach to the VPC | string | `` | no | | vpn\_gateway\_id | ID of VPN Gateway to attach to the VPC | string | `` | no |
| vpn_gateway_tags | Additional tags for the VPN gateway | string | `<map>` | no | | vpn\_gateway\_tags | Additional tags for the VPN gateway | map | `{}` | no |
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_route_table_ids | List of IDs of database route tables | | database\_route\_table\_ids | List of IDs of database route tables |
| database_subnet_group | ID of database subnet group | | database\_subnet\_group | ID of database subnet group |
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| database_subnets_cidr_blocks | List of cidr_blocks of database subnets | | database\_subnets\_cidr\_blocks | List of cidr_blocks of database subnets |
| default_network_acl_id | The ID of the default network ACL | | default\_network\_acl\_id | The ID of the default network ACL |
| default_route_table_id | The ID of the default route table | | default\_route\_table\_id | The ID of the default route table |
| default_security_group_id | The ID of the security group created by default on VPC creation | | default\_security\_group\_id | The ID of the security group created by default on VPC creation |
| default_vpc_cidr_block | The CIDR block of the VPC | | default\_vpc\_cidr\_block | The CIDR block of the VPC |
| default_vpc_default_network_acl_id | The ID of the default network ACL | | default\_vpc\_default\_network\_acl\_id | The ID of the default network ACL |
| default_vpc_default_route_table_id | The ID of the default route table | | default\_vpc\_default\_route\_table\_id | The ID of the default route table |
| default_vpc_default_security_group_id | The ID of the security group created by default on VPC creation | | default\_vpc\_default\_security\_group\_id | The ID of the security group created by default on VPC creation |
| default_vpc_enable_dns_hostnames | Whether or not the VPC has DNS hostname support | | default\_vpc\_enable\_dns\_hostnames | Whether or not the VPC has DNS hostname support |
| default_vpc_enable_dns_support | Whether or not the VPC has DNS support | | default\_vpc\_enable\_dns\_support | Whether or not the VPC has DNS support |
| default_vpc_id | The ID of the VPC | | default\_vpc\_id | The ID of the VPC |
| default_vpc_instance_tenancy | Tenancy of instances spin up within VPC | | default\_vpc\_instance\_tenancy | Tenancy of instances spin up within VPC |
| default_vpc_main_route_table_id | The ID of the main route table associated with this VPC | | default\_vpc\_main\_route\_table\_id | The ID of the main route table associated with this VPC |
| elasticache_route_table_ids | List of IDs of elasticache route tables | | elasticache\_route\_table\_ids | List of IDs of elasticache route tables |
| elasticache_subnet_group | ID of elasticache subnet group | | elasticache\_subnet\_group | ID of elasticache subnet group |
| elasticache_subnet_group_name | Name of elasticache subnet group | | elasticache\_subnet\_group\_name | Name of elasticache subnet group |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| elasticache_subnets_cidr_blocks | List of cidr_blocks of elasticache subnets | | elasticache\_subnets\_cidr\_blocks | List of cidr_blocks of elasticache subnets |
| igw_id | The ID of the Internet Gateway | | igw\_id | The ID of the Internet Gateway |
| intra_route_table_ids | List of IDs of intra route tables | | intra\_route\_table\_ids | List of IDs of intra route tables |
| intra_subnets | List of IDs of intra subnets | | intra\_subnets | List of IDs of intra subnets |
| intra_subnets_cidr_blocks | List of cidr_blocks of intra subnets | | intra\_subnets\_cidr\_blocks | List of cidr_blocks of intra subnets |
| nat_ids | List of allocation ID of Elastic IPs created for AWS NAT Gateway | | nat\_ids | List of allocation ID of Elastic IPs created for AWS NAT Gateway |
| nat_public_ips | List of public Elastic IPs created for AWS NAT Gateway | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| natgw_ids | List of NAT Gateway IDs | | natgw\_ids | List of NAT Gateway IDs |
| private_route_table_ids | List of IDs of private route tables | | private\_route\_table\_ids | List of IDs of private route tables |
| private_subnets | List of IDs of private subnets | | private\_subnets | List of IDs of private subnets |
| private_subnets_cidr_blocks | List of cidr_blocks of private subnets | | private\_subnets\_cidr\_blocks | List of cidr_blocks of private subnets |
| public_route_table_ids | List of IDs of public route tables | | public\_route\_table\_ids | List of IDs of public route tables |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| public_subnets_cidr_blocks | List of cidr_blocks of public subnets | | public\_subnets\_cidr\_blocks | List of cidr_blocks of public subnets |
| redshift_route_table_ids | List of IDs of redshift route tables | | redshift\_route\_table\_ids | List of IDs of redshift route tables |
| redshift_subnet_group | ID of redshift subnet group | | redshift\_subnet\_group | ID of redshift subnet group |
| redshift_subnets | List of IDs of redshift subnets | | redshift\_subnets | List of IDs of redshift subnets |
| redshift_subnets_cidr_blocks | List of cidr_blocks of redshift subnets | | redshift\_subnets\_cidr\_blocks | List of cidr_blocks of redshift subnets |
| vgw_id | The ID of the VPN Gateway | | vgw\_id | The ID of the VPN Gateway |
| vpc_cidr_block | The CIDR block of the VPC | | vpc\_cidr\_block | The CIDR block of the VPC |
| vpc_enable_dns_hostnames | Whether or not the VPC has DNS hostname support | | vpc\_enable\_dns\_hostnames | Whether or not the VPC has DNS hostname support |
| vpc_enable_dns_support | Whether or not the VPC has DNS support | | vpc\_enable\_dns\_support | Whether or not the VPC has DNS support |
| vpc_endpoint_dynamodb_id | The ID of VPC endpoint for DynamoDB | | vpc\_endpoint\_dynamodb\_id | The ID of VPC endpoint for DynamoDB |
| vpc_endpoint_dynamodb_pl_id | The prefix list for the DynamoDB VPC endpoint. | | vpc\_endpoint\_dynamodb\_pl\_id | The prefix list for the DynamoDB VPC endpoint. |
| vpc_endpoint_s3_id | The ID of VPC endpoint for S3 | | vpc\_endpoint\_s3\_id | The ID of VPC endpoint for S3 |
| vpc_endpoint_s3_pl_id | The prefix list for the S3 VPC endpoint. | | vpc\_endpoint\_s3\_pl\_id | The prefix list for the S3 VPC endpoint. |
| vpc_id | The ID of the VPC | | vpc\_id | The ID of the VPC |
| vpc_instance_tenancy | Tenancy of instances spin up within VPC | | vpc\_instance\_tenancy | Tenancy of instances spin up within VPC |
| vpc_main_route_table_id | The ID of the main route table associated with this VPC | | vpc\_main\_route\_table\_id | The ID of the main route table associated with this VPC |
| vpc_secondary_cidr_blocks | List of secondary CIDR blocks of the VPC | | vpc\_secondary\_cidr\_blocks | List of secondary CIDR blocks of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
......
examples/complete-vpc/README.md
View file @ 57604d2e
...@@ -17,18 +17,17 @@ $ terraform apply ...@@ -17,18 +17,17 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| intra_subnets | List of IDs of intra subnets | | intra\_subnets | List of IDs of intra subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| redshift_subnets | List of IDs of redshift subnets | | redshift\_subnets | List of IDs of redshift subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/issue-108-route-already-exists/README.md
View file @ 57604d2e
...@@ -19,16 +19,15 @@ $ terraform apply ...@@ -19,16 +19,15 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/issue-44-asymmetric-private-subnets/README.md
View file @ 57604d2e
...@@ -17,16 +17,15 @@ $ terraform apply ...@@ -17,16 +17,15 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/issue-46-no-private-subnets/README.md
View file @ 57604d2e
...@@ -17,16 +17,15 @@ $ terraform apply ...@@ -17,16 +17,15 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/manage-default-vpc/README.md
View file @ 57604d2e
...@@ -17,12 +17,11 @@ $ terraform apply ...@@ -17,12 +17,11 @@ $ terraform apply
Run `terraform destroy` when you don't need these resources. Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| default_vpc_cidr_block | The CIDR block of the VPC | | default\_vpc\_cidr\_block | The CIDR block of the VPC |
| default_vpc_id | Default VPC | | default\_vpc\_id | The ID of the Default VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/secondary-cidr-blocks/README.md
View file @ 57604d2e
...@@ -17,16 +17,15 @@ $ terraform apply ...@@ -17,16 +17,15 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_cidr_block | CIDR blocks | | vpc\_cidr\_block | The CIDR block of the VPC |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
| vpc_secondary_cidr_blocks | List of secondary CIDR blocks of the VPC | | vpc\_secondary\_cidr\_blocks | List of secondary CIDR blocks of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/simple-vpc/README.md
View file @ 57604d2e
...@@ -17,15 +17,14 @@ $ terraform apply ...@@ -17,15 +17,14 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_cidr_block | CIDR blocks | | vpc\_cidr\_block | The CIDR block of the VPC |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/test_fixture/README.md
View file @ 57604d2e
...@@ -21,12 +21,11 @@ Finished in 4.25 seconds (files took 2.75 seconds to load) ...@@ -21,12 +21,11 @@ Finished in 4.25 seconds (files took 2.75 seconds to load)
This will destroy any existing test resources, create the resources afresh, run the tests, report back, and destroy the resources. This will destroy any existing test resources, create the resources afresh, run the tests, report back, and destroy the resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Inputs ## Inputs
| Name | Description | Type | Default | Required | | Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:| |------|-------------|:----:|:-----:|:-----:|
| region | | string | `eu-west-1` | no | | region | - | string | `eu-west-1` | no |
## Outputs ## Outputs
......
examples/vpc-separate-private-route-tables/README.md
View file @ 57604d2e
...@@ -17,17 +17,16 @@ $ terraform apply ...@@ -17,17 +17,16 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| redshift_subnets | List of IDs of elasticache subnets | | redshift\_subnets | List of IDs of elasticache subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment