Package com.pulumi.aws.networkmanager

Class CustomerGatewayAssociation

  • public class CustomerGatewayAssociation
extends com.pulumi.resources.CustomResource
    Manages a Network Manager Customer Gateway Association. Use this resource to associate a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.networkmanager.GlobalNetwork;
 import com.pulumi.aws.networkmanager.GlobalNetworkArgs;
 import com.pulumi.aws.networkmanager.Site;
 import com.pulumi.aws.networkmanager.SiteArgs;
 import com.pulumi.aws.networkmanager.Device;
 import com.pulumi.aws.networkmanager.DeviceArgs;
 import com.pulumi.aws.ec2.CustomerGateway;
 import com.pulumi.aws.ec2.CustomerGatewayArgs;
 import com.pulumi.aws.ec2transitgateway.TransitGateway;
 import com.pulumi.aws.ec2.VpnConnection;
 import com.pulumi.aws.ec2.VpnConnectionArgs;
 import com.pulumi.aws.networkmanager.TransitGatewayRegistration;
 import com.pulumi.aws.networkmanager.TransitGatewayRegistrationArgs;
 import com.pulumi.aws.networkmanager.CustomerGatewayAssociation;
 import com.pulumi.aws.networkmanager.CustomerGatewayAssociationArgs;
 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) {
         var example = new GlobalNetwork("example", GlobalNetworkArgs.builder()
             .description("example")
             .build());
 
         var exampleSite = new Site("exampleSite", SiteArgs.builder()
             .globalNetworkId(example.id())
             .build());
 
         var exampleDevice = new Device("exampleDevice", DeviceArgs.builder()
             .globalNetworkId(example.id())
             .siteId(exampleSite.id())
             .build());
 
         var exampleCustomerGateway = new CustomerGateway("exampleCustomerGateway", CustomerGatewayArgs.builder()
             .bgpAsn("65000")
             .ipAddress("172.83.124.10")
             .type("ipsec.1")
             .build());
 
         var exampleTransitGateway = new TransitGateway("exampleTransitGateway");
 
         var exampleVpnConnection = new VpnConnection("exampleVpnConnection", VpnConnectionArgs.builder()
             .customerGatewayId(exampleCustomerGateway.id())
             .transitGatewayId(exampleTransitGateway.id())
             .type(exampleCustomerGateway.type())
             .staticRoutesOnly(true)
             .build());
 
         var exampleTransitGatewayRegistration = new TransitGatewayRegistration("exampleTransitGatewayRegistration", TransitGatewayRegistrationArgs.builder()
             .globalNetworkId(example.id())
             .transitGatewayArn(exampleTransitGateway.arn())
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleVpnConnection)
                 .build());
 
         var exampleCustomerGatewayAssociation = new CustomerGatewayAssociation("exampleCustomerGatewayAssociation", CustomerGatewayAssociationArgs.builder()
             .globalNetworkId(example.id())
             .customerGatewayArn(exampleCustomerGateway.arn())
             .deviceId(exampleDevice.id())
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleTransitGatewayRegistration)
                 .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.networkmanager.CustomerGatewayAssociation` using the global network ID and customer gateway ARN. For example: ```sh $ pulumi import aws:networkmanager/customerGatewayAssociation:CustomerGatewayAssociation example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-123abc05e04123abc ```

    • 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> customerGatewayArn()  
      com.pulumi.core.Output<java.lang.String> deviceId()  
      static CustomerGatewayAssociation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, CustomerGatewayAssociationState 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> globalNetworkId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> linkId()  

      • 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

      • CustomerGatewayAssociation

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

      • CustomerGatewayAssociation

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

      • CustomerGatewayAssociation

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

      • customerGatewayArn

        public com.pulumi.core.Output<java.lang.String> customerGatewayArn()
        Returns:
        ARN of the customer gateway.

      • deviceId

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

      • globalNetworkId

        public com.pulumi.core.Output<java.lang.String> globalNetworkId()
        Returns:
        ID of the global network. The following arguments are optional:

      • linkId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> linkId()
        Returns:
        ID of the link.

      • get

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