xpk/terraform.aws-baseline-infra
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

DOC: More updates on README.md

Browse Source
This commit is contained in:
xpk 2024-10-22 17:12:04 +08:00
parent 5a4570be72
commit d1741a0b29
Signed by: xpk
GPG Key ID: CD4FF6793F09AB86
2 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
modules/networking/VpcSubnet/README.md
View File

@ -1,4 +1,3 @@
<!-- This readme file is generated with terraform-docs -->
This module performs the following tasks: This module performs the following tasks:
- Create VPC, vpcflow log - Create VPC, vpcflow log
@ -6,6 +5,7 @@ This module performs the following tasks:
- Create IGW, NGW - Create IGW, NGW
- Create s3 and ddb endpoints which are free - Create s3 and ddb endpoints which are free
## Requirements ## Requirements
| Name | Version | | Name | Version |
@ -59,9 +59,9 @@ This module performs the following tasks:
| Name | Description | Type | Default | Required | | Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:| |------|-------------|------|---------|:--------:|
| create-free-vpc-endpoints | n/a | `bool` | `true` | no | | create-free-vpc-endpoints | Whether to deploy free VPC endpoints (s3 and dynamodb) | `bool` | `true` | no |
| create-nat-gateway | n/a | `bool` | `false` | no | | create-nat-gateway | Deploy NAT gateway for private subnets | `bool` | `false` | no |
| enable-flow-log | n/a | `bool` | `true` | no | | enable-flow-log | Whether to enable VPC flowlog | `bool` | `true` | no |
| flow-log-bucket-arn | Arn of S3 bucket to be used for flow logging | `string` | `null` | no | | flow-log-bucket-arn | Arn of S3 bucket to be used for flow logging | `string` | `null` | no |
| flow-log-destination | Destination of flowlog. Valid destinations are s3 or cwlog | `string` | `null` | no | | flow-log-destination | Destination of flowlog. Valid destinations are s3 or cwlog | `string` | `null` | no |
| multiaz-nat-gateway | Whether to deploy 1 NAT gateway for each AZ | `bool` | `false` | no | | multiaz-nat-gateway | Whether to deploy 1 NAT gateway for each AZ | `bool` | `false` | no |

11
modules/networking/VpcSubnet/variables.tf
View File

@ -22,8 +22,9 @@ variable "public-subnet-cidrs" {
} }
variable "create-nat-gateway" { variable "create-nat-gateway" {
type = bool description = "Deploy NAT gateway for private subnets"
default = false type = bool
default = false
} }
variable "multiaz-nat-gateway" { variable "multiaz-nat-gateway" {
@ -45,8 +46,9 @@ variable "flow-log-bucket-arn" {
} }
variable "enable-flow-log" { variable "enable-flow-log" {
type = bool description = "Whether to enable VPC flowlog"
default = true type = bool
default = true
} }
variable "vpcflowlog-retain-days" { variable "vpcflowlog-retain-days" {
@ -61,6 +63,7 @@ variable "vpcflowlog-cwl-loggroup-key-arn" {
} }
variable "create-free-vpc-endpoints" { variable "create-free-vpc-endpoints" {
description = "Whether to deploy free VPC endpoints (s3 and dynamodb)"
type = bool type = bool
default = true default = true
} }