AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a VPN connection.

Inheritance Hierarchy

System.Object
  Amazon.EC2.Model.VpnConnection

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class VpnConnection

The VpnConnection type exposes the following members

Constructors

NameDescription
Public Method VpnConnection()

Properties

NameTypeDescription
Public Property Category System.String

Gets and sets the property Category.

The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.

Public Property CoreNetworkArn System.String

Gets and sets the property CoreNetworkArn.

The ARN of the core network.

Public Property CoreNetworkAttachmentArn System.String

Gets and sets the property CoreNetworkAttachmentArn.

The ARN of the core network attachment.

Public Property CustomerGatewayConfiguration System.String

Gets and sets the property CustomerGatewayConfiguration.

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

Public Property CustomerGatewayId System.String

Gets and sets the property CustomerGatewayId.

The ID of the customer gateway at your end of the VPN connection.

Public Property GatewayAssociationState Amazon.EC2.GatewayAssociationState

Gets and sets the property GatewayAssociationState.

The current state of the gateway association.

Public Property Options Amazon.EC2.Model.VpnConnectionOptions

Gets and sets the property Options.

The VPN connection options.

Public Property PreSharedKeyArn System.String

Gets and sets the property PreSharedKeyArn.

The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.

Public Property Routes System.Collections.Generic.List<Amazon.EC2.Model.VpnStaticRoute>

Gets and sets the property Routes.

The static routes associated with the VPN connection.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property State Amazon.EC2.VpnState

Gets and sets the property State.

The current state of the VPN connection.

Public Property Tags System.Collections.Generic.List<Amazon.EC2.Model.Tag>

Gets and sets the property Tags.

Any tags assigned to the VPN connection.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property TransitGatewayId System.String

Gets and sets the property TransitGatewayId.

The ID of the transit gateway associated with the VPN connection.

Public Property Type Amazon.EC2.GatewayType

Gets and sets the property Type.

The type of VPN connection.

Public Property VgwTelemetry System.Collections.Generic.List<Amazon.EC2.Model.VgwTelemetry>

Gets and sets the property VgwTelemetry.

Information about the VPN tunnel.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property VpnConnectionId System.String

Gets and sets the property VpnConnectionId.

The ID of the VPN connection.

Public Property VpnGatewayId System.String

Gets and sets the property VpnGatewayId.

The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer