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.

Container for the parameters to the CreateClientVpnEndpoint operation. Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.CreateClientVpnEndpointRequest

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

Syntax

C#
public class CreateClientVpnEndpointRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CreateClientVpnEndpointRequest type exposes the following members

Constructors

Properties

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

Gets and sets the property AuthenticationOptions.

Information about the authentication method to be used to authenticate clients.

Public Property ClientCidrBlock System.String

Gets and sets the property ClientCidrBlock.

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

Public Property ClientConnectOptions Amazon.EC2.Model.ClientConnectOptions

Gets and sets the property ClientConnectOptions.

The options for managing connection authorization for new client connections.

Public Property ClientLoginBannerOptions Amazon.EC2.Model.ClientLoginBannerOptions

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 ClientToken System.String

Gets and sets the property ClientToken.

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Public Property ConnectionLogOptions Amazon.EC2.Model.ConnectionLogOptions

Gets and sets the property ConnectionLogOptions.

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

  • Client connection requests

  • Client connection results (successful and unsuccessful)

  • Reasons for unsuccessful client connection requests

  • Client connection termination time

Public Property Description System.String

Gets and sets the property Description.

A brief description of 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. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

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

Gets and sets the property SecurityGroupIds.

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

Public Property SelfServicePortal Amazon.EC2.SelfServicePortal

Gets and sets the property SelfServicePortal.

Specify whether to enable the self-service portal for the Client VPN endpoint.

Default Value: enabled

Public Property ServerCertificateArn System.String

Gets and sets the property ServerCertificateArn.

The ARN of the server certificate. For more information, see the Certificate Manager User Guide.

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 on the Client VPN endpoint.

By default, split-tunnel on a VPN endpoint is disabled.

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

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

Gets and sets the property TagSpecifications.

The tags to apply to the Client VPN endpoint during creation.

Public Property TransportProtocol Amazon.EC2.TransportProtocol

Gets and sets the property TransportProtocol.

The transport protocol to be used by the VPN session.

Default value: udp

Public Property VpcId System.String

Gets and sets the property VpcId.

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

Public Property VpnPort System.Int32

Gets and sets the property VpnPort.

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: 443 | 1194

Default Value: 443

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