Interface ICfnClientVpnEndpointProps

Properties for defining a CfnClientVpnEndpoint.

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnClientVpnEndpointProps

Syntax (vb)

Public Interface ICfnClientVpnEndpointProps

Remarks

See: 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;

             var 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"
                 },
                 ClientRouteEnforcementOptions = new ClientRouteEnforcementOptionsProperty {
                     Enforced = false
                 },
                 Description = "description",
                 DisconnectOnSessionTimeout = false,
                 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

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.
ClientRouteEnforcementOptions	Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.
ConnectionLogOptions	Information about the client connection logging options.
Description	A brief description of the Client VPN endpoint.
DisconnectOnSessionTimeout	Indicates whether the client VPN session is disconnected after the maximum `sessionTimeoutHours` is reached.
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.

Properties

AuthenticationOptions

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

object AuthenticationOptions { get; }

Property Value

object

Remarks

See: 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.

string ClientCidrBlock { get; }

Property Value

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. Client CIDR range must have a size of at least /22 and must not be greater than /12.

See: 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.

object? ClientConnectOptions { get; }

Property Value

object

Remarks

See: 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.

object? ClientLoginBannerOptions { get; }

Property Value

object

Remarks

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

ClientRouteEnforcementOptions

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.

object? ClientRouteEnforcementOptions { get; }

Property Value

object

Remarks

T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.

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

ConnectionLogOptions

Information about the client connection logging options.

object ConnectionLogOptions { get; }

Property Value

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:

See: 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.

string? Description { get; }

Property Value

string

Remarks

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

DisconnectOnSessionTimeout

Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached.

object? DisconnectOnSessionTimeout { get; }

Property Value

object

Remarks

If true , users are prompted to reconnect client VPN. If false , client VPN attempts to reconnect automatically. The default value is true .

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

DnsServers

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

string[]? DnsServers { get; }

Property Value

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.

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