Class CfnCustomerGatewayAssociation
Specifies an association between a customer gateway, a device, and optionally, a link.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.NetworkManager
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCustomerGatewayAssociation : CfnResource, IInspectable
Syntax (vb)
Public Class CfnCustomerGatewayAssociation
Inherits CfnResource
Implements IInspectable
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCustomerGatewayAssociation(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnCustomerGatewayAssociation(Construct, String, ICfnCustomerGatewayAssociationProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CustomerGatewayArn | The Amazon Resource Name (ARN) of the customer gateway. |
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. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCustomerGatewayAssociation(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCustomerGatewayAssociation(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCustomerGatewayAssociation(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCustomerGatewayAssociation(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnCustomerGatewayAssociation(Construct, String, ICfnCustomerGatewayAssociationProps)
public CfnCustomerGatewayAssociation(Construct scope, string id, ICfnCustomerGatewayAssociationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnCustomerGatewayAssociationProps
Resource properties.
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CustomerGatewayArn
The Amazon Resource Name (ARN) of the customer gateway.
public virtual string CustomerGatewayArn { get; set; }
Property Value
System.String
DeviceId
The ID of the device.
public virtual string DeviceId { get; set; }
Property Value
System.String
GlobalNetworkId
The ID of the global network.
public virtual string GlobalNetworkId { get; set; }
Property Value
System.String
LinkId
The ID of the link.
public virtual string LinkId { get; set; }
Property Value
System.String
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>