Skip to content

Resource: aws_vpc_dhcp_options#

Manages a DHCP options set for a VPC. For more information, see the documentation on DHCP options.

Example Usage#

Basic usage:

resource "aws_vpc_dhcp_options" "dns_resolver" {
  domain_name_servers = ["8.8.8.8", "8.8.4.4"]
}

Full usage:

resource "aws_vpc_dhcp_options" "foo" {
  domain_name          = "service.consul"
  domain_name_servers  = ["127.0.0.1", "10.0.0.2"]
  ntp_servers          = ["127.0.0.1"]
  netbios_name_servers = ["127.0.0.1"]
  netbios_node_type    = 2

  tags = {
    Name = "foo-name"
  }
}

Argument Reference#

The following arguments are supported:

  • domain_name - (Optional) the suffix domain name to use by default when resolving non fully qualified domain names. In other words, this is what ends up being the search value in the /etc/resolv.conf file.
  • domain_name_servers - (Optional) List of IP addresses of domain name servers or AmazonProvidedDNS. We recommend using only one of the two parameters.
  • ntp_servers - (Optional) List of NTP servers to configure. You can specify up to four IP addresses.
  • netbios_name_servers - (Optional) List of NETBIOS name servers. You can specify up to four IP addresses.
  • netbios_node_type - (Optional) The NetBIOS node type (1, 2, 4, or 8). For more information about these node types, see RFC 2132.
  • tags - (Optional) Map of tags to assign to the DHCP options set. If a provider default_tags configuration block is used, tags with matching keys will overwrite those defined at the provider level.

Remarks#

  • Notice that all arguments are optional, but you have to specify at least one argument.
  • domain_name_servers, netbios_name_servers, ntp_servers are limited to maximum four servers only.
  • To actually use the DHCP options set you need to associate it to a VPC using aws_vpc_dhcp_options_association.
  • If you delete a DHCP options set, all VPCs using it will be associated to default DHCP options set.
  • In most cases unless you're configuring your own DNS you'll want to set domain_name_servers to AmazonProvidedDNS.

Attribute Reference#

Supported attributes#

In addition to all arguments above, the following attributes are exported:

  • id - The ID of the DHCP options set.
  • arn - The Amazon Resource Name (ARN) of the DHCP options set.
  • tags_all - Map of tags assigned to the DHCP options set, including those inherited from the provider default_tags configuration block.

Unsupported attributes#

~> Note This attribute may be present in the terraform.tfstate file, but it has a preset value and cannot be specified in configuration files.

The following attribute is not currently supported: owner_id .

Import#

VPC DHCP options can be imported using the dhcp options id, e.g.,

$ terraform import aws_vpc_dhcp_options.my_options dopt-12345678