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
Terraform module to provision public and private [`subnets`](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) in an existing [`VPC`](https://aws.amazon.com/vpc)
@@ -56,7 +56,7 @@ module "subnets" {
56
56
providers = {
57
57
aws = "aws"
58
58
}
59
-
namespace = "cp"
59
+
namespace = "eg"
60
60
stage = "prod"
61
61
name = "app"
62
62
region = "us-east-1"
@@ -67,7 +67,7 @@ module "subnets" {
67
67
}
68
68
```
69
69
70
-
Learn about [using providers](https://www.terraform.io/docs/configuration-0-11/modules.html#providers-within-modules) with terraform modules.
70
+
Learn about [using providers](https://www.terraform.io/docs/configuration-0-11/modules.html#providers-within-modules) with terraform modules.
71
71
72
72
73
73
@@ -83,7 +83,7 @@ For subnet set calculation, the module uses Terraform interpolation
| Name | Description | Type | Default | Required |
162
162
|------|-------------|:----:|:-----:|:-----:|
163
-
| additional_tag_map | Additional tags for appending to each tag map | map |`<map>`| no |
164
-
| attributes | Any extra attributes for naming these resources | list |`<list>`| no |
165
-
| availability_zones | List of Availability Zones where subnets will be created | list | - | yes |
163
+
| additional_tag_map | Additional tags for appending to each tag map | map(string)|`<map>`| no |
164
+
| attributes | Any extra attributes for naming these resources | list(string)|`<list>`| no |
165
+
| availability_zones | List of Availability Zones where subnets will be created | list(string)| - | yes |
166
166
| cidr_block | Base CIDR block which will be divided into subnet CIDR blocks (e.g. `10.0.0.0/16`) | string | - | yes |
167
-
| context |The context output from an external label module to pass to the label modules within this module | map|`<map>`| no |
167
+
| context |Default context to use for passing state between label invocations | object|`<map>`| no |
168
168
| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes`| string |`-`| no |
169
169
| environment | The environment name if not using stage | string | `` | no |
170
170
| igw_id | Internet Gateway ID the public route table will point to (e.g. `igw-9c26a123`) | string | - | yes |
171
-
| label_order | The naming order of the id output and Name tag | list |`<list>`| no |
172
-
| map_public_ip_on_launch | Instances launched into a public subnet should be assigned a public IP address |string|`true`| no |
173
-
| max_subnet_count | Sets the maximum amount of subnets to deploy. 0 will deploy a subnet for every provided availablility zone (in `availability_zones` variable) within the region | string |`0`| no |
171
+
| label_order | The naming order of the ID output and Name tag | list(string)|`<list>`| no |
172
+
| map_public_ip_on_launch | Instances launched into a public subnet should be assigned a public IP address |bool|`true`| no |
173
+
| max_subnet_count | Sets the maximum amount of subnets to deploy. 0 will deploy a subnet for every provided availablility zone (in `availability_zones` variable) within the region | string |`0`| no |
174
174
| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no |
175
175
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no |
176
-
| nat_gateway_enabled | Flag to enable/disable NAT Gateways to allow servers in the private subnets to access the Internet |string|`true`| no |
177
-
| nat_instance_enabled | Flag to enable/disable NAT Instances to allow servers in the private subnets to access the Internet |string|`false`| no |
176
+
| nat_gateway_enabled | Flag to enable/disable NAT Gateways to allow servers in the private subnets to access the Internet |bool|`true`| no |
177
+
| nat_instance_enabled | Flag to enable/disable NAT Instances to allow servers in the private subnets to access the Internet |bool|`false`| no |
178
178
| nat_instance_type | NAT Instance type | string |`t3.micro`| no |
179
179
| private_network_acl_id | Network ACL ID that will be added to private subnets. If empty, a new ACL will be created | string | `` | no |
180
180
| public_network_acl_id | Network ACL ID that will be added to public subnets. If empty, a new ACL will be created | string | `` | no |
181
181
| regex_replace_chars | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. By default only hyphens, letters and digits are allowed, all other chars are removed | string |`/[^a-zA-Z0-9-]/`| no |
182
182
| stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test' | string | `` | no |
183
183
| subnet_type_tag_key | Key for subnet type tag to provide information about the type of subnets, e.g. `cpco.io/subnet/type=private` or `cpco.io/subnet/type=public`| string |`cpco.io/subnet/type`| no |
184
184
| subnet_type_tag_value_format | This is using the format interpolation symbols to allow the value of the subnet_type_tag_key to be modified. | string |`%s`| no |
185
-
| tags | Additional tags to apply to all resources that use this label module | map |`<map>`| no |
185
+
| tags | Additional tags to apply to all resources that use this label module | map(string)|`<map>`| no |
186
186
| vpc_default_route_table_id | Default route table for public subnets. If not set, will be created. (e.g. `rtb-f4f0ce12`) | string | `` | no |
187
187
| vpc_id | VPC ID where subnets will be created (e.g. `vpc-aceb2723`) | string | - | yes |
Copy file name to clipboardExpand all lines: docs/terraform.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,29 +2,29 @@
2
2
3
3
| Name | Description | Type | Default | Required |
4
4
|------|-------------|:----:|:-----:|:-----:|
5
-
| additional_tag_map | Additional tags for appending to each tag map | map |`<map>`| no |
6
-
| attributes | Any extra attributes for naming these resources | list |`<list>`| no |
7
-
| availability_zones | List of Availability Zones where subnets will be created | list | - | yes |
5
+
| additional_tag_map | Additional tags for appending to each tag map | map(string)|`<map>`| no |
6
+
| attributes | Any extra attributes for naming these resources | list(string)|`<list>`| no |
7
+
| availability_zones | List of Availability Zones where subnets will be created | list(string)| - | yes |
8
8
| cidr_block | Base CIDR block which will be divided into subnet CIDR blocks (e.g. `10.0.0.0/16`) | string | - | yes |
9
-
| context |The context output from an external label module to pass to the label modules within this module | map|`<map>`| no |
9
+
| context |Default context to use for passing state between label invocations | object|`<map>`| no |
10
10
| delimiter | Delimiter to be used between `namespace`, `stage`, `name` and `attributes`| string |`-`| no |
11
11
| environment | The environment name if not using stage | string | `` | no |
12
12
| igw_id | Internet Gateway ID the public route table will point to (e.g. `igw-9c26a123`) | string | - | yes |
13
-
| label_order | The naming order of the id output and Name tag | list |`<list>`| no |
14
-
| map_public_ip_on_launch | Instances launched into a public subnet should be assigned a public IP address |string|`true`| no |
15
-
| max_subnet_count | Sets the maximum amount of subnets to deploy. 0 will deploy a subnet for every provided availablility zone (in `availability_zones` variable) within the region | string |`0`| no |
13
+
| label_order | The naming order of the ID output and Name tag | list(string)|`<list>`| no |
14
+
| map_public_ip_on_launch | Instances launched into a public subnet should be assigned a public IP address |bool|`true`| no |
15
+
| max_subnet_count | Sets the maximum amount of subnets to deploy. 0 will deploy a subnet for every provided availablility zone (in `availability_zones` variable) within the region | string |`0`| no |
16
16
| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no |
17
17
| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no |
18
-
| nat_gateway_enabled | Flag to enable/disable NAT Gateways to allow servers in the private subnets to access the Internet |string|`true`| no |
19
-
| nat_instance_enabled | Flag to enable/disable NAT Instances to allow servers in the private subnets to access the Internet |string|`false`| no |
18
+
| nat_gateway_enabled | Flag to enable/disable NAT Gateways to allow servers in the private subnets to access the Internet |bool|`true`| no |
19
+
| nat_instance_enabled | Flag to enable/disable NAT Instances to allow servers in the private subnets to access the Internet |bool|`false`| no |
20
20
| nat_instance_type | NAT Instance type | string |`t3.micro`| no |
21
21
| private_network_acl_id | Network ACL ID that will be added to private subnets. If empty, a new ACL will be created | string | `` | no |
22
22
| public_network_acl_id | Network ACL ID that will be added to public subnets. If empty, a new ACL will be created | string | `` | no |
23
23
| regex_replace_chars | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. By default only hyphens, letters and digits are allowed, all other chars are removed | string |`/[^a-zA-Z0-9-]/`| no |
24
24
| stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test' | string | `` | no |
25
25
| subnet_type_tag_key | Key for subnet type tag to provide information about the type of subnets, e.g. `cpco.io/subnet/type=private` or `cpco.io/subnet/type=public`| string |`cpco.io/subnet/type`| no |
26
26
| subnet_type_tag_value_format | This is using the format interpolation symbols to allow the value of the subnet_type_tag_key to be modified. | string |`%s`| no |
27
-
| tags | Additional tags to apply to all resources that use this label module | map |`<map>`| no |
27
+
| tags | Additional tags to apply to all resources that use this label module | map(string)|`<map>`| no |
28
28
| vpc_default_route_table_id | Default route table for public subnets. If not set, will be created. (e.g. `rtb-f4f0ce12`) | string | `` | no |
29
29
| vpc_id | VPC ID where subnets will be created (e.g. `vpc-aceb2723`) | string | - | yes |
0 commit comments