CfnClientVpnEndpointProps

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

Bases: object

Properties for defining a AWS::EC2::ClientVpnEndpoint.

Parameters
  • authentication_options (Union[IResolvable, Sequence[Union[ClientAuthenticationRequestProperty, IResolvable]]]) – AWS::EC2::ClientVpnEndpoint.AuthenticationOptions.

  • client_cidr_block (str) – AWS::EC2::ClientVpnEndpoint.ClientCidrBlock.

  • client_connect_options (Union[IResolvable, ClientConnectOptionsProperty, None]) – AWS::EC2::ClientVpnEndpoint.ClientConnectOptions.

  • connection_log_options (Union[IResolvable, ConnectionLogOptionsProperty]) – AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions.

  • description (Optional[str]) – AWS::EC2::ClientVpnEndpoint.Description.

  • dns_servers (Optional[Sequence[str]]) – AWS::EC2::ClientVpnEndpoint.DnsServers.

  • security_group_ids (Optional[Sequence[str]]) – AWS::EC2::ClientVpnEndpoint.SecurityGroupIds.

  • self_service_portal (Optional[str]) – AWS::EC2::ClientVpnEndpoint.SelfServicePortal.

  • server_certificate_arn (str) – AWS::EC2::ClientVpnEndpoint.ServerCertificateArn.

  • split_tunnel (Union[bool, IResolvable, None]) – AWS::EC2::ClientVpnEndpoint.SplitTunnel.

  • tag_specifications (Union[IResolvable, Sequence[Union[IResolvable, TagSpecificationProperty]], None]) – AWS::EC2::ClientVpnEndpoint.TagSpecifications.

  • transport_protocol (Optional[str]) – AWS::EC2::ClientVpnEndpoint.TransportProtocol.

  • vpc_id (Optional[str]) – AWS::EC2::ClientVpnEndpoint.VpcId.

  • vpn_port (Union[int, float, None]) – AWS::EC2::ClientVpnEndpoint.VpnPort.

Link

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

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"
    ),
    description="description",
    dns_servers=["dnsServers"],
    security_group_ids=["securityGroupIds"],
    self_service_portal="selfServicePortal",
    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

AWS::EC2::ClientVpnEndpoint.AuthenticationOptions.

Link

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

Return type

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

client_cidr_block

AWS::EC2::ClientVpnEndpoint.ClientCidrBlock.

Link

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

Return type

str

client_connect_options

AWS::EC2::ClientVpnEndpoint.ClientConnectOptions.

Link

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

Return type

Union[IResolvable, ClientConnectOptionsProperty, None]

connection_log_options

AWS::EC2::ClientVpnEndpoint.ConnectionLogOptions.

Link

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

Return type

Union[IResolvable, ConnectionLogOptionsProperty]

description

AWS::EC2::ClientVpnEndpoint.Description.

Link

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

Return type

Optional[str]

dns_servers

AWS::EC2::ClientVpnEndpoint.DnsServers.

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

AWS::EC2::ClientVpnEndpoint.SecurityGroupIds.

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

AWS::EC2::ClientVpnEndpoint.SelfServicePortal.

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

AWS::EC2::ClientVpnEndpoint.ServerCertificateArn.

Link

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

Return type

str

split_tunnel

AWS::EC2::ClientVpnEndpoint.SplitTunnel.

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

AWS::EC2::ClientVpnEndpoint.TagSpecifications.

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

AWS::EC2::ClientVpnEndpoint.TransportProtocol.

Link

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

Return type

Optional[str]

vpc_id

AWS::EC2::ClientVpnEndpoint.VpcId.

Link

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

Return type

Optional[str]

vpn_port

AWS::EC2::ClientVpnEndpoint.VpnPort.

Link

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

Return type

Union[int, float, None]