Package software.amazon.awscdk.services.networkmanager

Class CfnCustomerGatewayAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.networkmanager.CfnCustomerGatewayAssociation
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ICustomerGatewayAssociationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:17.765Z") @Stability(Stable) public class CfnCustomerGatewayAssociation extends CfnResource implements IInspectable, ICustomerGatewayAssociationRef
Specifies an association between a customer gateway, a device, and optionally, a link.

If you specify a link, it must be associated with the specified device. The customer gateway must be connected to a VPN attachment on a transit gateway that's registered in your global network.

You cannot associate a customer gateway with more than one device and link.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.networkmanager.*;
 CfnCustomerGatewayAssociation cfnCustomerGatewayAssociation = CfnCustomerGatewayAssociation.Builder.create(this, "MyCfnCustomerGatewayAssociation")
         .customerGatewayArn("customerGatewayArn")
         .deviceId("deviceId")
         .globalNetworkId("globalNetworkId")
         // the properties below are optional
         .linkId("linkId")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCustomerGatewayAssociation

      protected CfnCustomerGatewayAssociation(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCustomerGatewayAssociation

      protected CfnCustomerGatewayAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCustomerGatewayAssociation

      @Stability(Stable) public CfnCustomerGatewayAssociation(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCustomerGatewayAssociationProps props)
      Create a new AWS::NetworkManager::CustomerGatewayAssociation.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnCustomerGatewayAssociation

      @Stability(Stable) @NotNull public static Boolean isCfnCustomerGatewayAssociation(@NotNull Object x)
      Checks whether the given object is a CfnCustomerGatewayAssociation.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCustomerGatewayAssociationRef

      @Stability(Stable) @NotNull public CustomerGatewayAssociationReference getCustomerGatewayAssociationRef()
      A reference to a CustomerGatewayAssociation resource.
      Specified by:
      getCustomerGatewayAssociationRef in interface ICustomerGatewayAssociationRef

    • getCustomerGatewayArn

      @Stability(Stable) @NotNull public String getCustomerGatewayArn()
      The Amazon Resource Name (ARN) of the customer gateway.

    • setCustomerGatewayArn

      @Stability(Stable) public void setCustomerGatewayArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the customer gateway.

    • getDeviceId

      @Stability(Stable) @NotNull public String getDeviceId()
      The ID of the device.

    • setDeviceId

      @Stability(Stable) public void setDeviceId(@NotNull String value)
      The ID of the device.

    • getGlobalNetworkId

      @Stability(Stable) @NotNull public String getGlobalNetworkId()
      The ID of the global network.

    • setGlobalNetworkId

      @Stability(Stable) public void setGlobalNetworkId(@NotNull String value)
      The ID of the global network.

    • getLinkId

      @Stability(Stable) @Nullable public String getLinkId()
      The ID of the link.

    • setLinkId

      @Stability(Stable) public void setLinkId(@Nullable String value)
      The ID of the link.