Package com.pulumi.aws.ec2

Class VpnGatewayAttachment

  • public class VpnGatewayAttachment
extends com.pulumi.resources.CustomResource
    Provides a Virtual Private Gateway attachment resource, allowing for an existing hardware VPN gateway to be attached and/or detached from a VPC. > **Note:** The `aws.ec2.VpnGateway` resource can also automatically attach the Virtual Private Gateway it creates to an existing VPC by setting the `vpcId` attribute accordingly. ## Example 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 com.pulumi.aws.ec2.VpnGateway;
 import com.pulumi.aws.ec2.VpnGatewayArgs;
 import com.pulumi.aws.ec2.VpnGatewayAttachment;
 import com.pulumi.aws.ec2.VpnGatewayAttachmentArgs;
 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 network = new Vpc("network", VpcArgs.builder()
             .cidrBlock("10.0.0.0/16")
             .build());
 
         var vpn = new VpnGateway("vpn", VpnGatewayArgs.builder()
             .tags(Map.of("Name", "example-vpn-gateway"))
             .build());
 
         var vpnAttachment = new VpnGatewayAttachment("vpnAttachment", VpnGatewayAttachmentArgs.builder()
             .vpcId(network.id())
             .vpnGatewayId(vpn.id())
             .build());
 
     }
 }
    See [VPC](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Introduction.html) and [Virtual Private Gateway](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html) user guides for more information. ## Import You cannot import this resource.

    • 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
      static VpnGatewayAttachment get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VpnGatewayAttachmentState 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> region()  
      com.pulumi.core.Output<java.lang.String> vpcId()  
      com.pulumi.core.Output<java.lang.String> vpnGatewayId()  

      • 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

      • VpnGatewayAttachment

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

      • VpnGatewayAttachment

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

      • VpnGatewayAttachment

        public VpnGatewayAttachment​(java.lang.String name,
                            VpnGatewayAttachmentArgs 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

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

      • vpcId

        public com.pulumi.core.Output<java.lang.String> vpcId()
        Returns:
        ID of the VPC.

      • vpnGatewayId

        public com.pulumi.core.Output<java.lang.String> vpnGatewayId()
        Returns:
        ID of the Virtual Private Gateway.

      • get

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