Package com.pulumi.aws.ec2

Class CustomerGateway

  • public class CustomerGateway
extends com.pulumi.resources.CustomResource
    Provides a customer gateway inside a VPC. These objects can be connected to VPN gateways via VPN connections, and allow you to establish tunnels between your network and the VPC. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ec2.CustomerGateway;
 import com.pulumi.aws.ec2.CustomerGatewayArgs;
 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 CustomerGateway("main", CustomerGatewayArgs.builder()
             .bgpAsn("65000")
             .ipAddress("172.83.124.10")
             .type("ipsec.1")
             .tags(Map.of("Name", "main-customer-gateway"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Customer Gateways using the `id`. For example: ```sh $ pulumi import aws:ec2/customerGateway:CustomerGateway main cgw-b4dc3961 ```

    • 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.String>> bgpAsn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> bgpAsnExtended()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificateArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> deviceName()  
      static CustomerGateway get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, CustomerGatewayState 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>> ipAddress()  
      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()  
      com.pulumi.core.Output<java.lang.String> type()  

      • 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

      • CustomerGateway

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

      • CustomerGateway

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

      • CustomerGateway

        public CustomerGateway​(java.lang.String name,
                       CustomerGatewayArgs 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:
        The ARN of the customer gateway.

      • bgpAsn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> bgpAsn()
        Returns:
        The gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values are from `1` to `2147483647`. Conflicts with `bgpAsnExtended`.

      • bgpAsnExtended

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> bgpAsnExtended()
        Returns:
        The gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values are from `2147483648` to `4294967295` Conflicts with `bgpAsn`.

      • certificateArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> certificateArn()
        Returns:
        ARN for the customer gateway certificate.

      • deviceName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> deviceName()
        Returns:
        A name for the customer gateway device.

      • ipAddress

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> ipAddress()
        Returns:
        The IPv4 address for the customer gateway device's outside interface.

      • 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:
        Tags to apply to the gateway. 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:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        The type of customer gateway. The only type AWS supports at this time is "ipsec.1".

      • get

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