Package com.pulumi.aws.ec2

Class Vpc

  • public class Vpc
extends com.pulumi.resources.CustomResource
    Provides a VPC resource. > **NOTE:** When AWS GuardDuty is enabled in your account, it automatically creates VPC endpoints and security groups in your VPCs to monitor network traffic. During VPC deletion, the provider automatically detects and removes these GuardDuty-managed VPC endpoints and security groups if they are blocking the deletion. This cleanup only targets resources tagged with `GuardDutyManaged=true` and happens automatically during destroy operations with no manual intervention required. For optimal functionality, the IAM role used by Terraform should have the optional permissions listed below. If these permissions are not available, the provider will continue with the deletion attempt and surface warnings only if the deletion ultimately fails. ## Example Usage Basic usage: 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ec2.Vpc;
 import com.pulumi.aws.ec2.VpcArgs;
 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 main = new Vpc("main", VpcArgs.builder()
             .cidrBlock("10.0.0.0/16")
             .build());
 
     }
 }
    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.Vpc;
 import com.pulumi.aws.ec2.VpcArgs;
 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 main = new Vpc("main", VpcArgs.builder()
             .cidrBlock("10.0.0.0/16")
             .instanceTenancy("default")
             .tags(Map.of("Name", "main"))
             .build());
 
     }
 }
    VPC with CIDR from AWS IPAM: 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.AwsFunctions;
 import com.pulumi.aws.inputs.GetRegionArgs;
 import com.pulumi.aws.ec2.VpcIpam;
 import com.pulumi.aws.ec2.VpcIpamArgs;
 import com.pulumi.aws.ec2.inputs.VpcIpamOperatingRegionArgs;
 import com.pulumi.aws.ec2.VpcIpamPool;
 import com.pulumi.aws.ec2.VpcIpamPoolArgs;
 import com.pulumi.aws.ec2.VpcIpamPoolCidr;
 import com.pulumi.aws.ec2.VpcIpamPoolCidrArgs;
 import com.pulumi.aws.ec2.Vpc;
 import com.pulumi.aws.ec2.VpcArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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) {
         final var current = AwsFunctions.getRegion(GetRegionArgs.builder()
             .build());
 
         var test = new VpcIpam("test", VpcIpamArgs.builder()
             .operatingRegions(VpcIpamOperatingRegionArgs.builder()
                 .regionName(current.region())
                 .build())
             .build());
 
         var testVpcIpamPool = new VpcIpamPool("testVpcIpamPool", VpcIpamPoolArgs.builder()
             .addressFamily("ipv4")
             .ipamScopeId(test.privateDefaultScopeId())
             .locale(current.region())
             .build());
 
         var testVpcIpamPoolCidr = new VpcIpamPoolCidr("testVpcIpamPoolCidr", VpcIpamPoolCidrArgs.builder()
             .ipamPoolId(testVpcIpamPool.id())
             .cidr("172.20.0.0/16")
             .build());
 
         var testVpc = new Vpc("testVpc", VpcArgs.builder()
             .ipv4IpamPoolId(testVpcIpamPool.id())
             .ipv4NetmaskLength(28)
             .build(), CustomResourceOptions.builder()
                 .dependsOn(testVpcIpamPoolCidr)
                 .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` (String) VPC ID. #### Optional * `accountId` (String) Account ID where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import VPCs using the VPC `id`. For example: ```sh $ pulumi import aws:ec2/vpc:Vpc test_vpc 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Vpc​(java.lang.String name)  
      Vpc​(java.lang.String name, VpcArgs args)  
      Vpc​(java.lang.String name, VpcArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • 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.lang.Boolean> enableDnsHostnames()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableDnsSupport()  
      com.pulumi.core.Output<java.lang.Boolean> enableNetworkAddressUsageMetrics()  
      static Vpc get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VpcState 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.util.Optional<java.lang.String>> instanceTenancy()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> ipv4IpamPoolId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> ipv4NetmaskLength()  
      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

      • Vpc

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

      • Vpc

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

      • Vpc

        public Vpc​(java.lang.String name,
           @Nullable
           VpcArgs 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()
        Returns:
        ARN of VPC.

      • assignGeneratedIpv6CidrBlock

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> assignGeneratedIpv6CidrBlock()
        Returns:
        Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. Default is `false`. Conflicts with `ipv6IpamPoolId`.

      • cidrBlock

        public com.pulumi.core.Output<java.lang.String> cidrBlock()
        Returns:
        IPv4 CIDR block for the VPC. CIDR can be explicitly set or it can be derived from IPAM using `ipv4NetmaskLength`.

      • defaultNetworkAclId

        public com.pulumi.core.Output<java.lang.String> defaultNetworkAclId()
        Returns:
        ID of the network ACL created by default on VPC creation.

      • defaultRouteTableId

        public com.pulumi.core.Output<java.lang.String> defaultRouteTableId()
        Returns:
        ID of the route table created by default on VPC creation.

      • defaultSecurityGroupId

        public com.pulumi.core.Output<java.lang.String> defaultSecurityGroupId()
        Returns:
        ID of the security group created by default on VPC creation.

      • dhcpOptionsId

        public com.pulumi.core.Output<java.lang.String> dhcpOptionsId()
        Returns:
        DHCP options ID of the desired VPC.

      • enableDnsHostnames

        public com.pulumi.core.Output<java.lang.Boolean> enableDnsHostnames()
        Returns:
        Whether to enable DNS hostnames in the VPC. Defaults to `false`.

      • enableDnsSupport

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enableDnsSupport()
        Returns:
        Whether to enable DNS support in the VPC. Defaults to `true`.

      • enableNetworkAddressUsageMetrics

        public com.pulumi.core.Output<java.lang.Boolean> enableNetworkAddressUsageMetrics()
        Returns:
        Whether to enable Network Address Usage metrics for your VPC. Defaults to `false`.

      • instanceTenancy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> instanceTenancy()
        Returns:
        Tenancy option for instances launched into the VPC. Default is `default`, which ensures that EC2 instances launched in this VPC use the EC2 instance tenancy attribute specified when the EC2 instance is launched. The only other option is `dedicated`, which ensures that EC2 instances launched in this VPC are run on dedicated tenancy instances regardless of the tenancy attribute specified at launch. This has a dedicated per region fee of $2 per hour, plus an hourly per instance usage fee.

      • ipv4IpamPoolId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> ipv4IpamPoolId()
        Returns:
        ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts. Using IPAM you can monitor IP address usage throughout your AWS Organization.

      • ipv4NetmaskLength

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> ipv4NetmaskLength()
        Returns:
        Netmask length of the IPv4 CIDR you want to allocate to this VPC. Requires specifying a `ipv4IpamPoolId`.

      • ipv6AssociationId

        public com.pulumi.core.Output<java.lang.String> ipv6AssociationId()
        Returns:
        Association ID for the IPv6 CIDR block.

      • ipv6CidrBlock

        public com.pulumi.core.Output<java.lang.String> ipv6CidrBlock()
        Returns:
        IPv6 CIDR block to request from an IPAM Pool. Can be set explicitly or derived from IPAM using `ipv6NetmaskLength`.

      • ipv6CidrBlockNetworkBorderGroup

        public com.pulumi.core.Output<java.lang.String> ipv6CidrBlockNetworkBorderGroup()
        Returns:
        By default when an IPv6 CIDR is assigned to a VPC a default ipv6CidrBlockNetworkBorderGroup will be set to the region of the VPC. This can be changed to restrict advertisement of public addresses to specific Network Border Groups such as LocalZones.

      • ipv6IpamPoolId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> ipv6IpamPoolId()
        Returns:
        IPAM Pool ID for a IPv6 pool. Conflicts with `assignGeneratedIpv6CidrBlock`.

      • ipv6NetmaskLength

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> ipv6NetmaskLength()
        Returns:
        Netmask length to request from IPAM Pool. Conflicts with `ipv6CidrBlock`. This can be omitted if IPAM pool as a `allocationDefaultNetmaskLength` set. Valid values are from `44` to `60` in increments of 4.

      • mainRouteTableId

        public com.pulumi.core.Output<java.lang.String> mainRouteTableId()
        Returns:
        ID of the main route table associated with this VPC. Note that you can change a VPC's main route table by using an `aws.ec2.MainRouteTableAssociation`.

      • ownerId

        public com.pulumi.core.Output<java.lang.String> ownerId()
        Returns:
        ID of the AWS account that owns the VPC.

      • 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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Vpc get​(java.lang.String name,
                      com.pulumi.core.Output<java.lang.String> id,
                      @Nullable
                      VpcState 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.