Skip to content

Commit

Permalink
Update description for variables
Browse files Browse the repository at this point in the history
  • Loading branch information
posquit0 committed Nov 7, 2023
1 parent fc71d90 commit bb619dd
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion modules/subnet-group/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ This module creates following resources.
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_name"></a> [name](#input\_name) | (Required) The name of the subnet group. | `string` | n/a | yes |
| <a name="input_subnets"></a> [subnets](#input\_subnets) | (Required) A configuration of subnets to create in the subnet group. Each block of `subnets` as defined below.<br> (Optional) `type` - The type of subnet. Valid values are `DUALSTACK` and `IPV6`. Defaults to `DUALSTACK`.<br> (Optional) `availability_zone` - The availability zone of the subnet. If the value of `availability_zone` and `availability_zone_id` are both not provided, the subnet will be created in random availability zone.<br> (Optional) `availability_zone_id` - The availability zone ID of the subnet. If the value of `availability_zone` and `availability_zone_id` are both not provided, the subnet will be created in random availability zone. | <pre>map(object({<br> type = optional(string, "DUALSTACK")<br><br> availability_zone = optional(string)<br> availability_zone_id = optional(string)<br><br> ipv4_cidr = optional(string)<br> ipv6_cidr = optional(string)<br> }))</pre> | n/a | yes |
| <a name="input_subnets"></a> [subnets](#input\_subnets) | (Required) A configuration of subnets to create in the subnet group. Each block of `subnets` as defined below.<br> (Optional) `type` - The type of subnet. Valid values are `DUALSTACK` and `IPV6`. Defaults to `DUALSTACK`.<br> (Optional) `availability_zone` - The availability zone of the subnet. If the value of `availability_zone` and `availability_zone_id` are both not provided, the subnet will be created in random availability zone.<br> (Optional) `availability_zone_id` - The availability zone ID of the subnet. If the value of `availability_zone` and `availability_zone_id` are both not provided, the subnet will be created in random availability zone.<br> (Optional) `ipv4_cidr` - The IPv4 CIDR block for the subnet.<br> (Optional) `ipv6_cidr` - The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length. | <pre>map(object({<br> type = optional(string, "DUALSTACK")<br><br> availability_zone = optional(string)<br> availability_zone_id = optional(string)<br><br> ipv4_cidr = optional(string)<br> ipv6_cidr = optional(string)<br> }))</pre> | n/a | yes |
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | (Required) The ID of the VPC which the subnet group belongs to. | `string` | n/a | yes |
| <a name="input_customer_owned_ipv4_address_assignment"></a> [customer\_owned\_ipv4\_address\_assignment](#input\_customer\_owned\_ipv4\_address\_assignment) | (Optional) A configuration for Customer-owned IPv4 address assignment. `customer_owned_ipv4_address_assignment` as defined below.<br> (Optional) `enabled` - Whether to automatically request a Customer-owned IPv4 address for a new network interface in this subnet. Defaults to `false`.<br> (Optional) `outpost` - The Amazon Resource Name (ARN) of the Outpost.<br> (Optional) `pool` - The customer owned IPv4 address pool. | <pre>object({<br> enabled = optional(bool, false)<br> outpost = optional(string)<br> pool = optional(string)<br> })</pre> | `{}` | no |
| <a name="input_dax_subnet_group"></a> [dax\_subnet\_group](#input\_dax\_subnet\_group) | (Optional) A configuration of DAX Subnet Group. `dax_subnet_group` as defined below.<br> (Optional) `enabled` - Whether to create DAX Subnet Group. Defaults to `false`.<br> (Optional) `name` - The name of the DAX Subnet Group. If not provided, the value of `name` will be used.<br> (Optional) `description` - The description of the DAX Subnet Group. | <pre>object({<br> enabled = optional(bool, false)<br> name = optional(string)<br> description = optional(string, "Managed by Terraform.")<br> })</pre> | `{}` | no |
Expand Down
2 changes: 2 additions & 0 deletions modules/subnet-group/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ variable "subnets" {
(Optional) `type` - The type of subnet. Valid values are `DUALSTACK` and `IPV6`. Defaults to `DUALSTACK`.
(Optional) `availability_zone` - The availability zone of the subnet. If the value of `availability_zone` and `availability_zone_id` are both not provided, the subnet will be created in random availability zone.
(Optional) `availability_zone_id` - The availability zone ID of the subnet. If the value of `availability_zone` and `availability_zone_id` are both not provided, the subnet will be created in random availability zone.
(Optional) `ipv4_cidr` - The IPv4 CIDR block for the subnet.
(Optional) `ipv6_cidr` - The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
EOF
type = map(object({
type = optional(string, "DUALSTACK")
Expand Down

0 comments on commit bb619dd

Please sign in to comment.