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
Copy file name to clipboardExpand all lines: README.md
+7-14Lines changed: 7 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -162,26 +162,23 @@ Available targets:
162
162
|------|-------------|:----:|:-----:|:-----:|
163
163
| additional_tag_map | Additional tags for appending to each tag map | map |`<map>`| no |
164
164
| attributes | Any extra attributes for naming these resources | list |`<list>`| no |
165
-
| availability_zones | List of Availability Zones where subnets will be created. When none provided, all availability zones will be used up to the number provided in the public_subnet_count and/or private_subnet_count, and then will be reused if the number of subnets requested is more than the number of availability zones | list |`<list>`|no|
166
-
| cidr_block | Base CIDR block which will be divided into subnet CIDR blocks (e.g. `10.0.0.0/16`), or pass in the vpc_id to use the CIDR from the VPC | string |``|no|
165
+
| availability_zones | List of Availability Zones where subnets will be created| list |-|yes|
166
+
| cidr_block | Base CIDR block which will be divided into subnet CIDR blocks (e.g. `10.0.0.0/16`)| string |-|yes|
167
167
| context | The context output from an external label module to pass to the label modules within this module | map |`<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
171
| label_order | The naming order of the id output and Name tag | list |`<list>`| no |
172
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 |The maximum number of subnets to deploy. 0 for none, -1 to match the number of az's in the region, or a specific number | string |`-1`| 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
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
177
| nat_instance_enabled | Flag to enable/disable NAT Instances to allow servers in the private subnets to access the Internet | string |`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
-
| private_subnet_count | Sets the amount of private subnets to deploy. -1 will deploy a subnet for every availablility zone within the region, 0 will deploy no subnets. The AZ's supplied will be cycled through to create the subnets | string |`-1`| no |
181
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 |
182
-
| public_subnet_count | Sets the amount of public subnets to deploy. -1 will deploy a subnet for every availablility zone within the region, 0 will deploy no subnets. The AZ's supplied will be cycled through to create the subnets | string |`-1`| no |
183
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 |
184
-
| region | The region to pass to the AWS provider nested in this module. | string | - | yes |
185
182
| stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test' | string | `` | no |
186
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 |
187
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 |
@@ -194,8 +191,6 @@ Available targets:
194
191
| Name | Description |
195
192
|------|-------------|
196
193
| availability_zones | List of Availability Zones where subnets were created |
197
-
| availability_zones_private | List of private Availability Zones where subnets were created |
198
-
| availability_zones_public | List of public Availability Zones where subnets were created |
199
194
| nat_gateway_ids | IDs of the NAT Gateways created |
200
195
| nat_instance_ids | IDs of the NAT Instances created |
201
196
| private_route_table_ids | IDs of the created private route tables |
@@ -343,27 +338,25 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
Copy file name to clipboardExpand all lines: docs/terraform.md
+3-8Lines changed: 3 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,26 +4,23 @@
4
4
|------|-------------|:----:|:-----:|:-----:|
5
5
| additional_tag_map | Additional tags for appending to each tag map | map |`<map>`| no |
6
6
| attributes | Any extra attributes for naming these resources | list |`<list>`| no |
7
-
| availability_zones | List of Availability Zones where subnets will be created. When none provided, all availability zones will be used up to the number provided in the public_subnet_count and/or private_subnet_count, and then will be reused if the number of subnets requested is more than the number of availability zones | list |`<list>`|no|
8
-
| cidr_block | Base CIDR block which will be divided into subnet CIDR blocks (e.g. `10.0.0.0/16`), or pass in the vpc_id to use the CIDR from the VPC | string |``|no|
7
+
| availability_zones | List of Availability Zones where subnets will be created| list |-|yes|
8
+
| cidr_block | Base CIDR block which will be divided into subnet CIDR blocks (e.g. `10.0.0.0/16`)| string |-|yes|
9
9
| context | The context output from an external label module to pass to the label modules within this module | map |`<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
13
| label_order | The naming order of the id output and Name tag | list |`<list>`| no |
14
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 |The maximum number of subnets to deploy. 0 for none, -1 to match the number of az's in the region, or a specific number | string |`-1`| 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
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
19
| nat_instance_enabled | Flag to enable/disable NAT Instances to allow servers in the private subnets to access the Internet | string |`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
-
| private_subnet_count | Sets the amount of private subnets to deploy. -1 will deploy a subnet for every availablility zone within the region, 0 will deploy no subnets. The AZ's supplied will be cycled through to create the subnets | string |`-1`| no |
23
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 |
24
-
| public_subnet_count | Sets the amount of public subnets to deploy. -1 will deploy a subnet for every availablility zone within the region, 0 will deploy no subnets. The AZ's supplied will be cycled through to create the subnets | string |`-1`| no |
25
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 |
26
-
| region | The region to pass to the AWS provider nested in this module. | string | - | yes |
27
24
| stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test' | string | `` | no |
28
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 |
29
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 |
@@ -36,8 +33,6 @@
36
33
| Name | Description |
37
34
|------|-------------|
38
35
| availability_zones | List of Availability Zones where subnets were created |
39
-
| availability_zones_private | List of private Availability Zones where subnets were created |
40
-
| availability_zones_public | List of public Availability Zones where subnets were created |
41
36
| nat_gateway_ids | IDs of the NAT Gateways created |
42
37
| nat_instance_ids | IDs of the NAT Instances created |
43
38
| private_route_table_ids | IDs of the created private route tables |
0 commit comments