DefaultVpc class

Provides a resource to manage the default AWS VPC in the current AWS Region.

If you created your AWS account after 2013-12-04 you have a default VPC in each AWS Region.

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.DefaultVpc resource behaves differently from normal resources in that if a default VPC exists, this provider does not create this resource, but instead "adopts" it into management. If no default VPC exists, the provider creates a new default VPC, which leads to the implicit creation of other resources. By default, pulumi destroy does not delete the default VPC but does remove the resource from the state. Set the forceDestroy argument to true to delete the default VPC.

Example Usage

Basic usage with tags:

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

const _default = new aws.ec2.DefaultVpc("default", {tags: {
    Name: "Default VPC",
}});
import pulumi
import pulumi_aws as aws

default = aws.ec2.DefaultVpc("default", tags={
    "Name": "Default VPC",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var @default = new Aws.Ec2.DefaultVpc("default", new()
    {
        Tags =
        {
            { "Name", "Default VPC" },
        },
    });

});
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.NewDefaultVpc(ctx, "default", &ec2.DefaultVpcArgs{
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Default VPC"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_defaultvpc" "default" {
  tags = {
    "Name" = "Default VPC"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.DefaultVpc;
import com.pulumi.aws.ec2.DefaultVpcArgs;
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 DefaultVpc("default", DefaultVpcArgs.builder()
            .tags(Map.of("Name", "Default VPC"))
            .build());

    }
}
resources:
  default:
    type: aws:ec2:DefaultVpc
    properties:
      tags:
        Name: Default VPC

Import

Identity Schema

Required

  • id (String) VPC ID.

Optional

  • accountId (String) AWS account ID for this resource.
  • region (String) AWS Region for this resource.

Using pulumi import, import Default VPCs using the VPC id. For example:

$ pulumi import aws:ec2/defaultVpc:DefaultVpc default vpc-a01106c2

Constructors

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

Properties

arn ↔ Output<String>
latefinal
assignGeneratedIpv6CidrBlock ↔ Output<bool?>
latefinal
childResources → Set<Resource>
finalinherited
cidrBlock ↔ Output<String>
The primary IPv4 CIDR block for the VPC
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
defaultNetworkAclId ↔ Output<String>
latefinal
defaultRouteTableId ↔ Output<String>
latefinal
defaultSecurityGroupId ↔ Output<String>
latefinal
dhcpOptionsId ↔ Output<String>
latefinal
enableDnsHostnames ↔ Output<bool?>
latefinal
enableDnsSupport ↔ Output<bool?>
latefinal
enableNetworkAddressUsageMetrics ↔ Output<bool>
latefinal
existingDefaultVpc ↔ Output<bool>
latefinal
forceDestroy ↔ Output<bool?>
Whether destroying the resource deletes the default VPC. Default: false
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
instanceTenancy ↔ Output<String>
The allowed tenancy of instances launched into the VPC
latefinal
ipv6AssociationId ↔ Output<String>
latefinal
ipv6CidrBlock ↔ Output<String>
latefinal
ipv6CidrBlockNetworkBorderGroup ↔ Output<String>
latefinal
ipv6IpamPoolId ↔ Output<String?>
latefinal
ipv6NetmaskLength ↔ Output<int?>
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
mainRouteTableId ↔ Output<String>
latefinal
ownerId ↔ Output<String>
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>?>
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, {DefaultVpcState? state, CustomResourceOptions? options}) → DefaultVpc
Gets an existing DefaultVpc resource's state with the given name and id.