CfnClientVpnEndpointProps

class aws_cdk.aws_ec2.CfnClientVpnEndpointProps(*, authentication_options, client_cidr_block, connection_log_options, server_certificate_arn, client_connect_options=None, client_login_banner_options=None, description=None, dns_servers=None, security_group_ids=None, self_service_portal=None, session_timeout_hours=None, split_tunnel=None, tag_specifications=None, transport_protocol=None, vpc_id=None, vpn_port=None)

Bases: object

Properties for defining a CfnClientVpnEndpoint.

Parameters
  • authentication_options (Union[IResolvable, Sequence[Union[IResolvable, ClientAuthenticationRequestProperty, Dict[str, Any]]]]) – Information about the authentication method to be used to authenticate clients.

  • client_cidr_block (str) – 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.

  • connection_log_options (Union[IResolvable, ConnectionLogOptionsProperty, Dict[str, Any]]) – 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

  • server_certificate_arn (str) – The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide .

  • client_connect_options (Union[IResolvable, ClientConnectOptionsProperty, Dict[str, Any], None]) – The options for managing connection authorization for new client connections.

  • client_login_banner_options (Union[IResolvable, ClientLoginBannerOptionsProperty, Dict[str, Any], None]) – Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

  • description (Optional[str]) – A brief description of the Client VPN endpoint.

  • dns_servers (Optional[Sequence[str]]) – 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.

  • security_group_ids (Optional[Sequence[str]]) – 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.

  • self_service_portal (Optional[str]) – Specify whether to enable the self-service portal for the Client VPN endpoint. Default Value: enabled

  • session_timeout_hours (Union[int, float, None]) – The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24 Default value: 24

  • split_tunnel (Union[bool, IResolvable, None]) – Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint. 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 .

  • tag_specifications (Union[IResolvable, Sequence[Union[IResolvable, TagSpecificationProperty, Dict[str, Any]]], None]) – The tags to apply to the Client VPN endpoint during creation.

  • transport_protocol (Optional[str]) – The transport protocol to be used by the VPN session. Default value: udp

  • vpc_id (Optional[str]) – 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.

  • vpn_port (Union[int, float, None]) – The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: 443 | 1194 Default Value: 443

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2 as ec2

cfn_client_vpn_endpoint_props = ec2.CfnClientVpnEndpointProps(
    authentication_options=[ec2.CfnClientVpnEndpoint.ClientAuthenticationRequestProperty(
        type="type",

        # the properties below are optional
        active_directory=ec2.CfnClientVpnEndpoint.DirectoryServiceAuthenticationRequestProperty(
            directory_id="directoryId"
        ),
        federated_authentication=ec2.CfnClientVpnEndpoint.FederatedAuthenticationRequestProperty(
            saml_provider_arn="samlProviderArn",

            # the properties below are optional
            self_service_saml_provider_arn="selfServiceSamlProviderArn"
        ),
        mutual_authentication=ec2.CfnClientVpnEndpoint.CertificateAuthenticationRequestProperty(
            client_root_certificate_chain_arn="clientRootCertificateChainArn"
        )
    )],
    client_cidr_block="clientCidrBlock",
    connection_log_options=ec2.CfnClientVpnEndpoint.ConnectionLogOptionsProperty(
        enabled=False,

        # the properties below are optional
        cloudwatch_log_group="cloudwatchLogGroup",
        cloudwatch_log_stream="cloudwatchLogStream"
    ),
    server_certificate_arn="serverCertificateArn",

    # the properties below are optional
    client_connect_options=ec2.CfnClientVpnEndpoint.ClientConnectOptionsProperty(
        enabled=False,

        # the properties below are optional
        lambda_function_arn="lambdaFunctionArn"
    ),
    client_login_banner_options=ec2.CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty(
        enabled=False,

        # the properties below are optional
        banner_text="bannerText"
    ),
    description="description",
    dns_servers=["dnsServers"],
    security_group_ids=["securityGroupIds"],
    self_service_portal="selfServicePortal",
    session_timeout_hours=123,
    split_tunnel=False,
    tag_specifications=[ec2.CfnClientVpnEndpoint.TagSpecificationProperty(
        resource_type="resourceType",
        tags=[CfnTag(
            key="key",
            value="value"
        )]
    )],
    transport_protocol="transportProtocol",
    vpc_id="vpcId",
    vpn_port=123
)

Attributes

authentication_options

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

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ClientAuthenticationRequestProperty]]]

client_cidr_block

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.

Link

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

Return type

str

client_connect_options

The options for managing connection authorization for new client connections.

Link

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

Return type

Union[IResolvable, ClientConnectOptionsProperty, None]

client_login_banner_options

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

Link

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

Return type

Union[IResolvable, ClientLoginBannerOptionsProperty, None]

connection_log_options

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

Link

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

Return type

Union[IResolvable, ConnectionLogOptionsProperty]

description

A brief description of the Client VPN endpoint.

Link

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

Return type

Optional[str]

dns_servers

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.

Link

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

Return type

Optional[List[str]]

security_group_ids

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.

Link

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

Return type

Optional[List[str]]

self_service_portal

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

Default Value: enabled

Link

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

Return type

Optional[str]

server_certificate_arn

The ARN of the server certificate.

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

Return type

str

session_timeout_hours

The maximum VPN session duration time in hours.

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

Return type

Union[int, float, None]

split_tunnel

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

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

Return type

Union[bool, IResolvable, None]

tag_specifications

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

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, TagSpecificationProperty]], None]

transport_protocol

The transport protocol to be used by the VPN session.

Default value: udp

Link

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

Return type

Optional[str]

vpc_id

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.

Link

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

Return type

Optional[str]

vpn_port

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

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

Return type

Union[int, float, None]