1. Docs
  2. Reference
  3. API
  4. AWS
  5. ec2
  6. VpcDhcpOptions

VpcDhcpOptions

Provides a VPC DHCP Options resource.

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 by AWS to maximum four servers only.
  • To actually use the DHCP Options Set you need to associate it to a VPC using aws.ec2.VpcDhcpOptionsAssociation.
  • If you delete a DHCP Options Set, all VPCs using it will be associated to AWS’s default DHCP Option Set.
  • In most cases unless you’re configuring your own DNS you’ll want to set domain_name_servers to AmazonProvidedDNS.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var dnsResolver = new Aws.Ec2.VpcDhcpOptions("dnsResolver", new Aws.Ec2.VpcDhcpOptionsArgs
        {
            DomainNameServers = 
            {
                "8.8.8.8",
                "8.8.4.4",
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/ec2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := ec2.NewVpcDhcpOptions(ctx, "dnsResolver", &ec2.VpcDhcpOptionsArgs{
            DomainNameServers: pulumi.StringArray{
                pulumi.String("8.8.8.8"),
                pulumi.String("8.8.4.4"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

dns_resolver = aws.ec2.VpcDhcpOptions("dnsResolver", domain_name_servers=[
    "8.8.8.8",
    "8.8.4.4",
])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const dnsResolver = new aws.ec2.VpcDhcpOptions("dns_resolver", {
    domainNameServers: [
        "8.8.8.8",
        "8.8.4.4",
    ],
});

Create a VpcDhcpOptions Resource

new VpcDhcpOptions(name: string, args?: VpcDhcpOptionsArgs, opts?: CustomResourceOptions);
def VpcDhcpOptions(resource_name, opts=None, domain_name=None, domain_name_servers=None, netbios_name_servers=None, netbios_node_type=None, ntp_servers=None, tags=None, __props__=None);
func NewVpcDhcpOptions(ctx *Context, name string, args *VpcDhcpOptionsArgs, opts ...ResourceOption) (*VpcDhcpOptions, error)
public VpcDhcpOptions(string name, VpcDhcpOptionsArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args VpcDhcpOptionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args VpcDhcpOptionsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VpcDhcpOptionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

VpcDhcpOptions Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The VpcDhcpOptions resource accepts the following input properties:

DomainName string

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.

DomainNameServers List<string>

List of name servers to configure in /etc/resolv.conf. If you want to use the default AWS nameservers you should set this to AmazonProvidedDNS.

NetbiosNameServers List<string>

List of NETBIOS name servers.

NetbiosNodeType string

The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see RFC 2132.

NtpServers List<string>

List of NTP servers to configure.

Tags Dictionary<string, string>

A map of tags to assign to the resource.

DomainName string

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.

DomainNameServers []string

List of name servers to configure in /etc/resolv.conf. If you want to use the default AWS nameservers you should set this to AmazonProvidedDNS.

NetbiosNameServers []string

List of NETBIOS name servers.

NetbiosNodeType string

The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see RFC 2132.

NtpServers []string

List of NTP servers to configure.

Tags map[string]string

A map of tags to assign to the resource.

domainName string

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.

domainNameServers string[]

List of name servers to configure in /etc/resolv.conf. If you want to use the default AWS nameservers you should set this to AmazonProvidedDNS.

netbiosNameServers string[]

List of NETBIOS name servers.

netbiosNodeType string

The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see RFC 2132.

ntpServers string[]

List of NTP servers to configure.

tags {[key: string]: string}

A map of tags to assign to the resource.

domain_name str

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 List[str]

List of name servers to configure in /etc/resolv.conf. If you want to use the default AWS nameservers you should set this to AmazonProvidedDNS.

netbios_name_servers List[str]

List of NETBIOS name servers.

netbios_node_type str

The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see RFC 2132.

ntp_servers List[str]

List of NTP servers to configure.

tags Dict[str, str]

A map of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the VpcDhcpOptions resource produces the following output properties:

Arn string

The ARN of the DHCP Options Set.

Id string
The provider-assigned unique ID for this managed resource.
OwnerId string

The ID of the AWS account that owns the DHCP options set.

Arn string

The ARN of the DHCP Options Set.

Id string
The provider-assigned unique ID for this managed resource.
OwnerId string

The ID of the AWS account that owns the DHCP options set.

arn string

The ARN of the DHCP Options Set.

id string
The provider-assigned unique ID for this managed resource.
ownerId string

The ID of the AWS account that owns the DHCP options set.

arn str

The ARN of the DHCP Options Set.

id str
The provider-assigned unique ID for this managed resource.
owner_id str

The ID of the AWS account that owns the DHCP options set.

Look up an Existing VpcDhcpOptions Resource

Get an existing VpcDhcpOptions resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VpcDhcpOptionsState, opts?: CustomResourceOptions): VpcDhcpOptions
static get(resource_name, id, opts=None, arn=None, domain_name=None, domain_name_servers=None, netbios_name_servers=None, netbios_node_type=None, ntp_servers=None, owner_id=None, tags=None, __props__=None);
func GetVpcDhcpOptions(ctx *Context, name string, id IDInput, state *VpcDhcpOptionsState, opts ...ResourceOption) (*VpcDhcpOptions, error)
public static VpcDhcpOptions Get(string name, Input<string> id, VpcDhcpOptionsState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string

The ARN of the DHCP Options Set.

DomainName string

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.

DomainNameServers List<string>

List of name servers to configure in /etc/resolv.conf. If you want to use the default AWS nameservers you should set this to AmazonProvidedDNS.

NetbiosNameServers List<string>

List of NETBIOS name servers.

NetbiosNodeType string

The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see RFC 2132.

NtpServers List<string>

List of NTP servers to configure.

OwnerId string

The ID of the AWS account that owns the DHCP options set.

Tags Dictionary<string, string>

A map of tags to assign to the resource.

Arn string

The ARN of the DHCP Options Set.

DomainName string

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.

DomainNameServers []string

List of name servers to configure in /etc/resolv.conf. If you want to use the default AWS nameservers you should set this to AmazonProvidedDNS.

NetbiosNameServers []string

List of NETBIOS name servers.

NetbiosNodeType string

The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see RFC 2132.

NtpServers []string

List of NTP servers to configure.

OwnerId string

The ID of the AWS account that owns the DHCP options set.

Tags map[string]string

A map of tags to assign to the resource.

arn string

The ARN of the DHCP Options Set.

domainName string

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.

domainNameServers string[]

List of name servers to configure in /etc/resolv.conf. If you want to use the default AWS nameservers you should set this to AmazonProvidedDNS.

netbiosNameServers string[]

List of NETBIOS name servers.

netbiosNodeType string

The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see RFC 2132.

ntpServers string[]

List of NTP servers to configure.

ownerId string

The ID of the AWS account that owns the DHCP options set.

tags {[key: string]: string}

A map of tags to assign to the resource.

arn str

The ARN of the DHCP Options Set.

domain_name str

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 List[str]

List of name servers to configure in /etc/resolv.conf. If you want to use the default AWS nameservers you should set this to AmazonProvidedDNS.

netbios_name_servers List[str]

List of NETBIOS name servers.

netbios_node_type str

The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see RFC 2132.

ntp_servers List[str]

List of NTP servers to configure.

owner_id str

The ID of the AWS account that owns the DHCP options set.

tags Dict[str, str]

A map of tags to assign to the resource.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.