Skip to content

Commit 661d211

Browse files
andreaswittigantonbabenko
authored andcommitted
Improving DHCP options docs (terraform-aws-modules#260)
* Improving DHCP options docs * generating README from variables description
1 parent 8c238b8 commit 661d211

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -234,12 +234,12 @@ Terraform version 0.10.3 or newer is required for this module to work.
234234
| default\_vpc\_enable\_dns\_support | Should be true to enable DNS support in the Default VPC | string | `"true"` | no |
235235
| default\_vpc\_name | Name to be used on the Default VPC | string | `""` | no |
236236
| default\_vpc\_tags | Additional tags for the Default VPC | map | `{}` | no |
237-
| dhcp\_options\_domain\_name | Specifies DNS name for DHCP options set | string | `""` | no |
238-
| dhcp\_options\_domain\_name\_servers | Specify a list of DNS server addresses for DHCP options set, default to AWS provided | list | `[ "AmazonProvidedDNS" ]` | no |
239-
| dhcp\_options\_netbios\_name\_servers | Specify a list of netbios servers for DHCP options set | list | `[]` | no |
240-
| dhcp\_options\_netbios\_node\_type | Specify netbios node_type for DHCP options set | string | `""` | no |
241-
| dhcp\_options\_ntp\_servers | Specify a list of NTP servers for DHCP options set | list | `[]` | no |
242-
| dhcp\_options\_tags | Additional tags for the DHCP option set | map | `{}` | no |
237+
| dhcp\_options\_domain\_name | Specifies DNS name for DHCP options set (requires enable_dhcp_options set to true) | string | `""` | no |
238+
| dhcp\_options\_domain\_name\_servers | Specify a list of DNS server addresses for DHCP options set, default to AWS provided (requires enable_dhcp_options set to true) | list | `[ "AmazonProvidedDNS" ]` | no |
239+
| dhcp\_options\_netbios\_name\_servers | Specify a list of netbios servers for DHCP options set (requires enable_dhcp_options set to true) | list | `[]` | no |
240+
| dhcp\_options\_netbios\_node\_type | Specify netbios node_type for DHCP options set (requires enable_dhcp_options set to true) | string | `""` | no |
241+
| dhcp\_options\_ntp\_servers | Specify a list of NTP servers for DHCP options set (requires enable_dhcp_options set to true) | list | `[]` | no |
242+
| dhcp\_options\_tags | Additional tags for the DHCP option set (requires enable_dhcp_options set to true) | map | `{}` | no |
243243
| ec2\_endpoint\_private\_dns\_enabled | Whether or not to associate a private hosted zone with the specified VPC for EC2 endpoint | string | `"false"` | no |
244244
| ec2\_endpoint\_security\_group\_ids | The ID of one or more security groups to associate with the network interface for EC2 endpoint | list | `[]` | no |
245245
| ec2\_endpoint\_subnet\_ids | The ID of one or more subnets in which to create a network interface for EC2 endpoint. Only a single subnet within an AZ is supported. If omitted, private subnets will be used. | list | `[]` | no |

variables.tf

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ variable "elasticache_acl_tags" {
490490
}
491491

492492
variable "dhcp_options_tags" {
493-
description = "Additional tags for the DHCP option set"
493+
description = "Additional tags for the DHCP option set (requires enable_dhcp_options set to true)"
494494
default = {}
495495
}
496496

@@ -515,30 +515,30 @@ variable "enable_dhcp_options" {
515515
}
516516

517517
variable "dhcp_options_domain_name" {
518-
description = "Specifies DNS name for DHCP options set"
518+
description = "Specifies DNS name for DHCP options set (requires enable_dhcp_options set to true)"
519519
default = ""
520520
}
521521

522522
variable "dhcp_options_domain_name_servers" {
523-
description = "Specify a list of DNS server addresses for DHCP options set, default to AWS provided"
523+
description = "Specify a list of DNS server addresses for DHCP options set, default to AWS provided (requires enable_dhcp_options set to true)"
524524

525525
default = ["AmazonProvidedDNS"]
526526
}
527527

528528
variable "dhcp_options_ntp_servers" {
529-
description = "Specify a list of NTP servers for DHCP options set"
529+
description = "Specify a list of NTP servers for DHCP options set (requires enable_dhcp_options set to true)"
530530

531531
default = []
532532
}
533533

534534
variable "dhcp_options_netbios_name_servers" {
535-
description = "Specify a list of netbios servers for DHCP options set"
535+
description = "Specify a list of netbios servers for DHCP options set (requires enable_dhcp_options set to true)"
536536

537537
default = []
538538
}
539539

540540
variable "dhcp_options_netbios_node_type" {
541-
description = "Specify netbios node_type for DHCP options set"
541+
description = "Specify netbios node_type for DHCP options set (requires enable_dhcp_options set to true)"
542542
default = ""
543543
}
544544

0 commit comments

Comments
 (0)