DefaultVpcDhcpOptions class

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:

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",
}});
import pulumi
import pulumi_aws as aws

default = aws.ec2.DefaultVpcDhcpOptions("default", tags={
    "Name": "Default DHCP Option Set",
})
using System.Collections.Generic;
using System.Linq;
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/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_defaultvpcdhcpoptions" "default" {
  tags = {
    "Name" = "Default DHCP Option Set"
  }
}
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.ArrayList;
import java.util.Arrays;
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());

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

Import

Using pulumi import, import VPC DHCP Options using the DHCP Options id. For example:

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

Constructors

DefaultVpcDhcpOptions(String name, {DefaultVpcDhcpOptionsArgs? args, CustomResourceOptions? options})
Creates a new DefaultVpcDhcpOptions. name The Pulumi resource name. args Arguments used to configure this DefaultVpcDhcpOptions. The set of arguments for DefaultVpcDhcpOptions. options Resource options controlling this resource's behavior.
DefaultVpcDhcpOptions.reference(String urn)
Creates a typed reference to an existing DefaultVpcDhcpOptions resource.

Properties

arn ↔ Output<String>
The ARN of the DHCP Options Set.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
domainName ↔ Output<String>
latefinal
domainNameServers ↔ Output<String>
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
ipv6AddressPreferredLeaseTime ↔ Output<String>
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
netbiosNameServers ↔ Output<String>
List of NETBIOS name servers.
latefinal
netbiosNodeType ↔ Output<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.
latefinal
ntpServers ↔ Output<String>
latefinal
ownerId ↔ Output<String>
The ID of the AWS account that owns the DHCP options set.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DefaultVpcDhcpOptionsState? state, CustomResourceOptions? options}) → DefaultVpcDhcpOptions
Gets an existing DefaultVpcDhcpOptions resource's state with the given name and id.