Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jarpat committed Oct 5, 2023
1 parent ca53317 commit 18e0340
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/CONFIG-VARS.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ You can use `default_public_access_cidrs` to set a default range for all created
| :--- | ---: | ---: | ---: | ---: |
| vpc_cidr | Address space for the VPC | string | "192.168.0.0/16" | This variable is ignored when `vpc_id` is set (AKA bring your own VPC). |
| subnets | Subnets to be created and their settings | map | See below for default values | This variable is ignored when `subnet_ids` is set (AKA bring your own subnets). All defined subnets must exist within the VPC address space. |
| subnet_azs | Configure specific AZs you want the subnets to created in. The values must be distinct | optional map | {} see below for an example | If not defined or if not enough zones are listed to match the definitions in `subnets`, the code will perform a lookup to get a list of AZs in your selected region. This variable is ignored when `subnet_ids` is set (AKA bring your own subnets).|

The default values for the subnets variable are as follows:

Expand All @@ -97,6 +98,18 @@ The default values for the subnets variable are as follows:
}
```

Example for `subnet_azs`:

The zones below define allow you to configure where each subnet in the map above will be created.
e.g. for `"private" : ["192.168.0.0/18", "192.168.64.0/18"]`, the first subnet will be created in `us-east-2c` and the second in `us-east-2b`
```terraform
subnet_azs = {
"private" : ["us-east-2c", "us-east-2b"],
"public" : ["us-east-2a", "us-east-2b"],
"database" : ["us-east-2a", "us-east-2b"]
}
```

### Use Existing
If desired, you can deploy into an existing VPC, subnet and NAT gateway, and Security Group.

Expand Down

0 comments on commit 18e0340

Please sign in to comment.