Class CfnCustomerGatewayAssociation
Specifies an association between a customer gateway, a device, and optionally, a link.
Inherited Members
Namespace: Amazon.CDK.AWS.NetworkManager
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCustomerGatewayAssociation : CfnResource, IInspectable, ICustomerGatewayAssociationRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnCustomerGatewayAssociation Inherits CfnResource Implements IInspectable, ICustomerGatewayAssociationRef, IConstruct, IDependable, IEnvironmentAware
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.NetworkManager;
var cfnCustomerGatewayAssociation = new CfnCustomerGatewayAssociation(this, "MyCfnCustomerGatewayAssociation", new CfnCustomerGatewayAssociationProps {
CustomerGatewayArn = "customerGatewayArn",
DeviceId = "deviceId",
GlobalNetworkId = "globalNetworkId",
// the properties below are optional
LinkId = "linkId"
});
Synopsis
Constructors
| CfnCustomerGatewayAssociation(Construct, string, ICfnCustomerGatewayAssociationProps) | Create a new |
Properties
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | Specifies an association between a customer gateway, a device, and optionally, a link. |
| CustomerGatewayArn | The Amazon Resource Name (ARN) of the customer gateway. |
| CustomerGatewayAssociationRef | A reference to a CustomerGatewayAssociation resource. |
| DeviceId | The ID of the device. |
| GlobalNetworkId | The ID of the global network. |
| LinkId | The ID of the link. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnCustomerGatewayAssociation(object) | Checks whether the given object is a CfnCustomerGatewayAssociation. |
| RenderProperties(IDictionary<string, object>) | Specifies an association between a customer gateway, a device, and optionally, a link. |
Constructors
CfnCustomerGatewayAssociation(Construct, string, ICfnCustomerGatewayAssociationProps)
Create a new AWS::NetworkManager::CustomerGatewayAssociation.
public CfnCustomerGatewayAssociation(Construct scope, string id, ICfnCustomerGatewayAssociationProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnCustomerGatewayAssociationProps
Resource properties.
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
CfnProperties
Specifies an association between a customer gateway, a device, and optionally, a link.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
CustomerGatewayArn
The Amazon Resource Name (ARN) of the customer gateway.
public virtual string CustomerGatewayArn { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
CustomerGatewayAssociationRef
A reference to a CustomerGatewayAssociation resource.
public virtual ICustomerGatewayAssociationReference CustomerGatewayAssociationRef { get; }
Property Value
ICustomerGatewayAssociationReference
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
DeviceId
The ID of the device.
public virtual string DeviceId { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
GlobalNetworkId
The ID of the global network.
public virtual string GlobalNetworkId { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
LinkId
The ID of the link.
public virtual string? LinkId { get; set; }
Property Value
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
IsCfnCustomerGatewayAssociation(object)
Checks whether the given object is a CfnCustomerGatewayAssociation.
public static bool IsCfnCustomerGatewayAssociation(object x)
Parameters
- x object
Returns
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Specifies an association between a customer gateway, a device, and optionally, a link.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
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.
CloudformationResource: AWS::NetworkManager::CustomerGatewayAssociation
ExampleMetadata: fixture=_generated