Class CfnClientVpnEndpointProps

Properties for defining a CfnClientVpnEndpoint.

Inheritance

System.Object

CfnClientVpnEndpointProps

Implements

ICfnClientVpnEndpointProps

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.AWS.EC2.dll

Syntax (csharp)

public class CfnClientVpnEndpointProps : Object, ICfnClientVpnEndpointProps

Syntax (vb)

Public Class CfnClientVpnEndpointProps
    Inherits Object
    Implements ICfnClientVpnEndpointProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html

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.EC2;

CfnClientVpnEndpointProps cfnClientVpnEndpointProps = new CfnClientVpnEndpointProps {
    AuthenticationOptions = new [] { new ClientAuthenticationRequestProperty {
        Type = "type",

        // the properties below are optional
        ActiveDirectory = new DirectoryServiceAuthenticationRequestProperty {
            DirectoryId = "directoryId"
        },
        FederatedAuthentication = new FederatedAuthenticationRequestProperty {
            SamlProviderArn = "samlProviderArn",

            // the properties below are optional
            SelfServiceSamlProviderArn = "selfServiceSamlProviderArn"
        },
        MutualAuthentication = new CertificateAuthenticationRequestProperty {
            ClientRootCertificateChainArn = "clientRootCertificateChainArn"
        }
    } },
    ClientCidrBlock = "clientCidrBlock",
    ConnectionLogOptions = new ConnectionLogOptionsProperty {
        Enabled = false,

        // the properties below are optional
        CloudwatchLogGroup = "cloudwatchLogGroup",
        CloudwatchLogStream = "cloudwatchLogStream"
    },
    ServerCertificateArn = "serverCertificateArn",

    // the properties below are optional
    ClientConnectOptions = new ClientConnectOptionsProperty {
        Enabled = false,

        // the properties below are optional
        LambdaFunctionArn = "lambdaFunctionArn"
    },
    ClientLoginBannerOptions = new ClientLoginBannerOptionsProperty {
        Enabled = false,

        // the properties below are optional
        BannerText = "bannerText"
    },
    Description = "description",
    DnsServers = new [] { "dnsServers" },
    SecurityGroupIds = new [] { "securityGroupIds" },
    SelfServicePortal = "selfServicePortal",
    SessionTimeoutHours = 123,
    SplitTunnel = false,
    TagSpecifications = new [] { new TagSpecificationProperty {
        ResourceType = "resourceType",
        Tags = new [] { new CfnTag {
            Key = "key",
            Value = "value"
        } }
    } },
    TransportProtocol = "transportProtocol",
    VpcId = "vpcId",
    VpnPort = 123
};

Synopsis

Constructors

CfnClientVpnEndpointProps()

Properties

AuthenticationOptions	Information about the authentication method to be used to authenticate clients.
ClientCidrBlock	The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
ClientConnectOptions	The options for managing connection authorization for new client connections.
ClientLoginBannerOptions	Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
ConnectionLogOptions	Information about the client connection logging options.
Description	A brief description of the Client VPN endpoint.
DnsServers	Information about the DNS servers to be used for DNS resolution.
SecurityGroupIds	The IDs of one or more security groups to apply to the target network.
SelfServicePortal	Specify whether to enable the self-service portal for the Client VPN endpoint.
ServerCertificateArn	The ARN of the server certificate.
SessionTimeoutHours	The maximum VPN session duration time in hours.
SplitTunnel	Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
TagSpecifications	The tags to apply to the Client VPN endpoint during creation.
TransportProtocol	The transport protocol to be used by the VPN session.
VpcId	The ID of the VPC to associate with the Client VPN endpoint.
VpnPort	The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Constructors

CfnClientVpnEndpointProps()

public CfnClientVpnEndpointProps()

Properties

AuthenticationOptions

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

public object AuthenticationOptions { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions

ClientCidrBlock

The IPv4 address range, in CIDR notation, from which to assign client IP addresses.

public string ClientCidrBlock { get; set; }

Property Value

System.String

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientcidrblock

ClientConnectOptions

The options for managing connection authorization for new client connections.

public object ClientConnectOptions { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientconnectoptions

ClientLoginBannerOptions

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

public object ClientLoginBannerOptions { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions

ConnectionLogOptions

Information about the client connection logging options.

public object ConnectionLogOptions { get; set; }

Property Value

System.Object

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions

Description

A brief description of the Client VPN endpoint.

public string Description { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-description

DnsServers

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

public string[] DnsServers { get; set; }

Property Value

System.String[]

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-dnsservers

SecurityGroupIds

The IDs of one or more security groups to apply to the target network.

public string[] SecurityGroupIds { get; set; }

Property Value

System.String[]

Remarks

You must also specify the ID of the VPC that contains the security groups.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-securitygroupids

SelfServicePortal

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

public string SelfServicePortal { get; set; }

Property Value

System.String

Remarks

Default Value: enabled

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-selfserviceportal

ServerCertificateArn

The ARN of the server certificate.

public string ServerCertificateArn { get; set; }

Property Value

System.String

Remarks

For more information, see the AWS Certificate Manager User Guide .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-servercertificatearn

SessionTimeoutHours

The maximum VPN session duration time in hours.

public Nullable<double> SessionTimeoutHours { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Valid values: 8 | 10 | 12 | 24

Default value: 24

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-sessiontimeouthours

SplitTunnel

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

public object SplitTunnel { get; set; }

Property Value

System.Object

Remarks

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

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel

TagSpecifications

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

public object TagSpecifications { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications

TransportProtocol

The transport protocol to be used by the VPN session.

public string TransportProtocol { get; set; }

Property Value

System.String

Remarks

Default value: udp

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-transportprotocol

VpcId

The ID of the VPC to associate with the Client VPN endpoint.

public string VpcId { get; set; }

Property Value

System.String

Remarks

If no security group IDs are specified in the request, the default security group for the VPC is applied.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpcid

VpnPort

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

public Nullable<double> VpnPort { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Valid Values: 443 | 1194

Default Value: 443

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport

Implements

ICfnClientVpnEndpointProps