Class DefaultVpc


  • public class DefaultVpc
    extends com.pulumi.resources.CustomResource
    Provides a resource to manage the [default AWS VPC](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/default-vpc.html) 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](https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html#default-vpc-components). 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:
     
     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());
     
         }
     }
     
     
    ## 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: ```sh $ pulumi import aws:ec2/defaultVpc:DefaultVpc default vpc-a01106c2 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> assignGeneratedIpv6CidrBlock()  
      com.pulumi.core.Output<java.lang.String> cidrBlock()  
      com.pulumi.core.Output<java.lang.String> defaultNetworkAclId()  
      com.pulumi.core.Output<java.lang.String> defaultRouteTableId()  
      com.pulumi.core.Output<java.lang.String> defaultSecurityGroupId()  
      com.pulumi.core.Output<java.lang.String> dhcpOptionsId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableDnsHostnames()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableDnsSupport()  
      com.pulumi.core.Output<java.lang.Boolean> enableNetworkAddressUsageMetrics()  
      com.pulumi.core.Output<java.lang.Boolean> existingDefaultVpc()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceDestroy()  
      static DefaultVpc get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DefaultVpcState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> instanceTenancy()  
      com.pulumi.core.Output<java.lang.String> ipv6AssociationId()  
      com.pulumi.core.Output<java.lang.String> ipv6CidrBlock()  
      com.pulumi.core.Output<java.lang.String> ipv6CidrBlockNetworkBorderGroup()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> ipv6IpamPoolId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> ipv6NetmaskLength()  
      com.pulumi.core.Output<java.lang.String> mainRouteTableId()  
      com.pulumi.core.Output<java.lang.String> ownerId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DefaultVpc

        public DefaultVpc​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • DefaultVpc

        public DefaultVpc​(java.lang.String name,
                          @Nullable
                          DefaultVpcArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • DefaultVpc

        public DefaultVpc​(java.lang.String name,
                          @Nullable
                          DefaultVpcArgs args,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
      • assignGeneratedIpv6CidrBlock

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> assignGeneratedIpv6CidrBlock()
      • cidrBlock

        public com.pulumi.core.Output<java.lang.String> cidrBlock()
        Returns:
        The primary IPv4 CIDR block for the VPC
      • defaultNetworkAclId

        public com.pulumi.core.Output<java.lang.String> defaultNetworkAclId()
      • defaultRouteTableId

        public com.pulumi.core.Output<java.lang.String> defaultRouteTableId()
      • defaultSecurityGroupId

        public com.pulumi.core.Output<java.lang.String> defaultSecurityGroupId()
      • dhcpOptionsId

        public com.pulumi.core.Output<java.lang.String> dhcpOptionsId()
      • enableDnsHostnames

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableDnsHostnames()
      • enableDnsSupport

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableDnsSupport()
      • enableNetworkAddressUsageMetrics

        public com.pulumi.core.Output<java.lang.Boolean> enableNetworkAddressUsageMetrics()
      • existingDefaultVpc

        public com.pulumi.core.Output<java.lang.Boolean> existingDefaultVpc()
      • forceDestroy

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceDestroy()
        Returns:
        Whether destroying the resource deletes the default VPC. Default: `false`
      • instanceTenancy

        public com.pulumi.core.Output<java.lang.String> instanceTenancy()
        Returns:
        The allowed tenancy of instances launched into the VPC
      • ipv6AssociationId

        public com.pulumi.core.Output<java.lang.String> ipv6AssociationId()
      • ipv6CidrBlock

        public com.pulumi.core.Output<java.lang.String> ipv6CidrBlock()
      • ipv6CidrBlockNetworkBorderGroup

        public com.pulumi.core.Output<java.lang.String> ipv6CidrBlockNetworkBorderGroup()
      • ipv6IpamPoolId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> ipv6IpamPoolId()
      • ipv6NetmaskLength

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> ipv6NetmaskLength()
      • mainRouteTableId

        public com.pulumi.core.Output<java.lang.String> mainRouteTableId()
      • ownerId

        public com.pulumi.core.Output<java.lang.String> ownerId()
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
      • get

        public static DefaultVpc get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     DefaultVpcState state,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.