AWS SDK Version 3 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 Client VPN endpoint.

Inheritance Hierarchy

System.Object
  Amazon.EC2.Model.ClientVpnEndpoint

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

Syntax

C#
public class ClientVpnEndpoint

The ClientVpnEndpoint type exposes the following members

Constructors

NameDescription
Public Method ClientVpnEndpoint()

Properties

NameTypeDescription
Public Property AssociatedTargetNetworks System.Collections.Generic.List<Amazon.EC2.Model.AssociatedTargetNetwork>

Gets and sets the property AssociatedTargetNetworks.

Information about the associated target networks. A target network is a subnet in a VPC.

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

Gets and sets the property AuthenticationOptions.

Information about the authentication method used by the Client VPN endpoint.

Public Property ClientCidrBlock System.String

Gets and sets the property ClientCidrBlock.

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

Public Property ClientConnectOptions Amazon.EC2.Model.ClientConnectResponseOptions

Gets and sets the property ClientConnectOptions.

The options for managing connection authorization for new client connections.

Public Property ClientLoginBannerOptions Amazon.EC2.Model.ClientLoginBannerResponseOptions

Gets and sets the property ClientLoginBannerOptions.

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

Public Property ClientVpnEndpointId System.String

Gets and sets the property ClientVpnEndpointId.

The ID of the Client VPN endpoint.

Public Property ConnectionLogOptions Amazon.EC2.Model.ConnectionLogResponseOptions

Gets and sets the property ConnectionLogOptions.

Information about the client connection logging options for the Client VPN endpoint.

Public Property CreationTime System.String

Gets and sets the property CreationTime.

The date and time the Client VPN endpoint was created.

Public Property DeletionTime System.String

Gets and sets the property DeletionTime.

The date and time the Client VPN endpoint was deleted, if applicable.

Public Property Description System.String

Gets and sets the property Description.

A brief description of the endpoint.

Public Property DnsName System.String

Gets and sets the property DnsName.

The DNS name to be used by clients when connecting to the Client VPN endpoint.

Public Property DnsServers System.Collections.Generic.List<System.String>

Gets and sets the property DnsServers.

Information about the DNS servers to be used for DNS resolution.

Public Property SecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property SecurityGroupIds.

The IDs of the security groups for the target network.

Public Property SelfServicePortalUrl System.String

Gets and sets the property SelfServicePortalUrl.

The URL of the self-service portal.

Public Property ServerCertificateArn System.String

Gets and sets the property ServerCertificateArn.

The ARN of the server certificate.

Public Property SessionTimeoutHours System.Int32

Gets and sets the property SessionTimeoutHours.

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

Public Property SplitTunnel System.Boolean

Gets and sets the property SplitTunnel.

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.

Public Property Status Amazon.EC2.Model.ClientVpnEndpointStatus

Gets and sets the property Status.

The current state of the Client VPN endpoint.

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

Gets and sets the property Tags.

Any tags assigned to the Client VPN endpoint.

Public Property TransportProtocol Amazon.EC2.TransportProtocol

Gets and sets the property TransportProtocol.

The transport protocol used by the Client VPN endpoint.

Public Property VpcId System.String

Gets and sets the property VpcId.

The ID of the VPC.

Public Property VpnPort System.Int32

Gets and sets the property VpnPort.

The port number for the Client VPN endpoint.

Public Property VpnProtocol Amazon.EC2.VpnProtocol

Gets and sets the property VpnProtocol.

The protocol used by the VPN session.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5