AWS Classic v5.32.0, Mar 17 23

aws.ec2.DefaultVpcDhcpOptions

Provides a resource to manage the default AWS DHCP Options Set in the current region.

Each AWS region comes with a default set of DHCP options. This is an advanced resource, and has special caveats to be aware of when using it. Please read this document in its entirety before using this resource.

The aws.ec2.DefaultVpcDhcpOptions behaves differently from normal resources, in that this provider does not create this resource, but instead “adopts” it into management.

Example Usage

Basic usage with tags

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.Ec2.DefaultVpcDhcpOptions("default", new()
    {
        Tags = 
        {
            { "Name", "Default DHCP Option Set" },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewDefaultVpcDhcpOptions(ctx, "default", &ec2.DefaultVpcDhcpOptionsArgs{
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Default DHCP Option Set"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.DefaultVpcDhcpOptions;
import com.pulumi.aws.ec2.DefaultVpcDhcpOptionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new DefaultVpcDhcpOptions("default", DefaultVpcDhcpOptionsArgs.builder()        
            .tags(Map.of("Name", "Default DHCP Option Set"))
            .build());

    }
}

import pulumi
import pulumi_aws as aws

default = aws.ec2.DefaultVpcDhcpOptions("default", tags={
    "Name": "Default DHCP Option Set",
})

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const _default = new aws.ec2.DefaultVpcDhcpOptions("default", {tags: {
    Name: "Default DHCP Option Set",
}});

resources:
  default:
    type: aws:ec2:DefaultVpcDhcpOptions
    properties:
      tags:
        Name: Default DHCP Option Set

Create DefaultVpcDhcpOptions Resource

new DefaultVpcDhcpOptions(name: string, args?: DefaultVpcDhcpOptionsArgs, opts?: CustomResourceOptions);

@overload
def DefaultVpcDhcpOptions(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          owner_id: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None)
@overload
def DefaultVpcDhcpOptions(resource_name: str,
                          args: Optional[DefaultVpcDhcpOptionsArgs] = None,
                          opts: Optional[ResourceOptions] = None)

func NewDefaultVpcDhcpOptions(ctx *Context, name string, args *DefaultVpcDhcpOptionsArgs, opts ...ResourceOption) (*DefaultVpcDhcpOptions, error)

public DefaultVpcDhcpOptions(string name, DefaultVpcDhcpOptionsArgs? args = null, CustomResourceOptions? opts = null)

public DefaultVpcDhcpOptions(String name, DefaultVpcDhcpOptionsArgs args)
public DefaultVpcDhcpOptions(String name, DefaultVpcDhcpOptionsArgs args, CustomResourceOptions options)

type: aws:ec2:DefaultVpcDhcpOptions
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DefaultVpcDhcpOptionsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DefaultVpcDhcpOptionsArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DefaultVpcDhcpOptionsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DefaultVpcDhcpOptionsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DefaultVpcDhcpOptionsArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

DefaultVpcDhcpOptions Resource Properties

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

Inputs

The DefaultVpcDhcpOptions resource accepts the following input properties:

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.

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.

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.

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.

owner_id str: The ID of the AWS account that owns the DHCP options set.
tags Mapping[str, str]: A map of tags to assign to the resource.

ownerId String: The ID of the AWS account that owns the DHCP options set.
tags Map<String>: A map of tags to assign to the resource.

Outputs

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

Arn string: The ARN of the DHCP Options Set.
DomainName string
DomainNameServers string
Id string: The provider-assigned unique ID for this managed resource.
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
TagsAll Dictionary<string, string>

Arn string: The ARN of the DHCP Options Set.
DomainName string
DomainNameServers string
Id string: The provider-assigned unique ID for this managed resource.
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
TagsAll map[string]string

arn String: The ARN of the DHCP Options Set.
domainName String
domainNameServers String
id String: The provider-assigned unique ID for this managed resource.
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
tagsAll Map<String,String>

arn string: The ARN of the DHCP Options Set.
domainName string
domainNameServers string
id string: The provider-assigned unique ID for this managed resource.
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
tagsAll {[key: string]: string}

arn str: The ARN of the DHCP Options Set.
domain_name str
domain_name_servers str
id str: The provider-assigned unique ID for this managed resource.
netbios_name_servers 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 str
tags_all Mapping[str, str]

arn String: The ARN of the DHCP Options Set.
domainName String
domainNameServers String
id String: The provider-assigned unique ID for this managed resource.
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
tagsAll Map<String>

Look up Existing DefaultVpcDhcpOptions Resource

Get an existing DefaultVpcDhcpOptions 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?: DefaultVpcDhcpOptionsState, opts?: CustomResourceOptions): DefaultVpcDhcpOptions

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        domain_name: Optional[str] = None,
        domain_name_servers: Optional[str] = None,
        netbios_name_servers: Optional[str] = None,
        netbios_node_type: Optional[str] = None,
        ntp_servers: Optional[str] = None,
        owner_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> DefaultVpcDhcpOptions

func GetDefaultVpcDhcpOptions(ctx *Context, name string, id IDInput, state *DefaultVpcDhcpOptionsState, opts ...ResourceOption) (*DefaultVpcDhcpOptions, error)

public static DefaultVpcDhcpOptions Get(string name, Input<string> id, DefaultVpcDhcpOptionsState? state, CustomResourceOptions? opts = null)

public static DefaultVpcDhcpOptions get(String name, Output<String> id, DefaultVpcDhcpOptionsState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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.

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
DomainNameServers string
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
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.
TagsAll Dictionary<string, string>

Arn string: The ARN of the DHCP Options Set.
DomainName string
DomainNameServers string
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
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.
TagsAll map[string]string

arn String: The ARN of the DHCP Options Set.
domainName String
domainNameServers String
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
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.
tagsAll Map<String,String>

arn string: The ARN of the DHCP Options Set.
domainName string
domainNameServers string
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
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.
tagsAll {[key: string]: string}

arn str: The ARN of the DHCP Options Set.
domain_name str
domain_name_servers str
netbios_name_servers 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 str
owner_id str: The ID of the AWS account that owns the DHCP options set.
tags Mapping[str, str]: A map of tags to assign to the resource.
tags_all Mapping[str, str]

arn String: The ARN of the DHCP Options Set.
domainName String
domainNameServers String
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
ownerId String: The ID of the AWS account that owns the DHCP options set.
tags Map<String>: A map of tags to assign to the resource.
tagsAll Map<String>

Import

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

 $ pulumi import aws:ec2/defaultVpcDhcpOptions:DefaultVpcDhcpOptions default_options dopt-d9070ebb

Package Details

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