create_client_vpn_endpoint ¶

def create_client_vpn_endpoint(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    client_cidr_block: Optional["capo_ec2.types.string.String"] = None,
    server_certificate_arn: Optional["capo_ec2.types.string.String"] = None,
    authentication_options: Optional[
        "capo_ec2.types.client_vpn_authentication_request_list.ClientVpnAuthenticationRequestList"
    ] = None,
    connection_log_options: Optional[
        "capo_ec2.types.connection_log_options.ConnectionLogOptions"
    ] = None,
    dns_servers: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    transport_protocol: Optional[
        "capo_ec2.types.transport_protocol.TransportProtocol"
    ] = None,
    vpn_port: Optional["capo_ec2.types.integer.Integer"] = None,
    description: Optional["capo_ec2.types.string.String"] = None,
    split_tunnel: Optional["capo_ec2.types.boolean.Boolean"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    security_group_ids: Optional[
        "capo_ec2.types.client_vpn_security_group_id_set.ClientVpnSecurityGroupIdSet"
    ] = None,
    vpc_id: Optional["capo_ec2.types.vpc_id.VpcId"] = None,
    self_service_portal: Optional[
        "capo_ec2.types.self_service_portal.SelfServicePortal"
    ] = None,
    client_connect_options: Optional[
        "capo_ec2.types.client_connect_options.ClientConnectOptions"
    ] = None,
    session_timeout_hours: Optional["capo_ec2.types.integer.Integer"] = None,
    client_login_banner_options: Optional[
        "capo_ec2.types.client_login_banner_options.ClientLoginBannerOptions"
    ] = None,
    client_route_enforcement_options: Optional[
        "capo_ec2.types.client_route_enforcement_options.ClientRouteEnforcementOptions"
    ] = None,
    disconnect_on_session_timeout: Optional[
        "capo_ec2.types.boolean.Boolean"
    ] = None,
    endpoint_ip_address_type: Optional[
        "capo_ec2.types.endpoint_ip_address_type.EndpointIpAddressType"
    ] = None,
    traffic_ip_address_type: Optional[
        "capo_ec2.types.traffic_ip_address_type.TrafficIpAddressType"
    ] = None,
    transit_gateway_configuration: Optional[
        "capo_ec2.types.transit_gateway_configuration_input_structure.TransitGatewayConfigurationInputStructure"
    ] = None,
    device_posture_options: Optional[
        "capo_ec2.types.device_posture_options.DevicePostureOptions"
    ] = None,
) -> (
    "capo_ec2.types.create_client_vpn_endpoint_result.CreateClientVpnEndpointResult"
):
    """<p>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.</p>

    Args:
        client_cidr_block: <p>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. Client CIDR range must have a size of at least /22 and must not be greater than /12.</p>
        server_certificate_arn: <p>The ARN of the server certificate. For more information, see the <a href="https://docs.aws.amazon.com/acm/latest/userguide/">Certificate Manager User Guide</a>.</p>
        authentication_options: <p>Information about the authentication method to be used to authenticate clients.</p>
        connection_log_options: <p>Information about the client connection logging options.</p> <p>If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:</p> <ul> <li> <p>Client connection requests</p> </li> <li> <p>Client connection results (successful and unsuccessful)</p> </li> <li> <p>Reasons for unsuccessful client connection requests</p> </li> <li> <p>Client connection termination time</p> </li> </ul>
        dns_servers: <p>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.</p>
        transport_protocol: <p>The transport protocol to be used by the VPN session.</p> <p>Default value: <code>udp</code> </p>
        vpn_port: <p>The port number to assign to the Client VPN endpoint for TCP and UDP traffic.</p> <p>Valid Values: <code>443</code> | <code>1194</code> </p> <p>Default Value: <code>443</code> </p>
        description: <p>A brief description of the Client VPN endpoint.</p>
        split_tunnel: <p>Indicates whether split-tunnel is enabled on the Client VPN endpoint.</p> <p>By default, split-tunnel on a VPN endpoint is disabled.</p> <p>For information about split-tunnel VPN endpoints, see <a href="https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html">Split-tunnel Client VPN endpoint</a> in the <i>Client VPN Administrator Guide</i>.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p>
        tag_specifications: <p>The tags to apply to the Client VPN endpoint during creation.</p>
        security_group_ids: <p>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.</p>
        vpc_id: <p>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.</p>
        self_service_portal: <p>Specify whether to enable the self-service portal for the Client VPN endpoint.</p> <p>Default Value: <code>enabled</code> </p>
        client_connect_options: <p>The options for managing connection authorization for new client connections.</p>
        session_timeout_hours: <p>The maximum VPN session duration time in hours.</p> <p>Valid values: <code>8 | 10 | 12 | 24</code> </p> <p>Default value: <code>24</code> </p>
        client_login_banner_options: <p>Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.</p>
        client_route_enforcement_options: <p>Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. 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.</p> <p>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.</p>
        disconnect_on_session_timeout: <p>Indicates whether the client VPN session is disconnected after the maximum timeout specified in <code>SessionTimeoutHours</code> is reached. If <code>true</code>, users are prompted to reconnect client VPN. If <code>false</code>, client VPN attempts to reconnect automatically. The default value is <code>true</code>.</p>
        endpoint_ip_address_type: <p>The IP address type for the Client VPN endpoint. Valid values are <code>ipv4</code> (default) for IPv4 addressing only, <code>ipv6</code> for IPv6 addressing only, or <code>dual-stack</code> for both IPv4 and IPv6 addressing. When set to <code>dual-stack,</code> clients can connect to the endpoint using either IPv4 or IPv6 addresses..</p>
        traffic_ip_address_type: <p>The IP address type for traffic within the Client VPN tunnel. Valid values are <code>ipv4</code> (default) for IPv4 traffic only, <code>ipv6</code> for IPv6 addressing only, or <code>dual-stack</code> for both IPv4 and IPv6 traffic. When set to <code>dual-stack</code>, clients can access both IPv4 and IPv6 resources through the VPN .</p>
        transit_gateway_configuration: <p>The Transit Gateway configuration for the Client VPN endpoint. Use this parameter to associate the endpoint with a Transit Gateway instead of a VPC. You cannot specify both <code>TransitGatewayConfiguration</code> and <code>VpcId</code>/<code>SecurityGroupIds</code>.</p>
        device_posture_options: <p>The device posture options for the Client VPN endpoint. Use this parameter to specify the device trust providers that the endpoint uses to evaluate the security posture of connecting devices.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_client_vpn_endpoint_request.CreateClientVpnEndpointRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_client_vpn_endpoint_result.CreateClientVpnEndpointResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_client_vpn_endpoint

        output, http_response = (
            capo_ec2._operations.amazon_ec2.create_client_vpn_endpoint.create_client_vpn_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateClientVpnEndpoint")
    )
    input_: capo_ec2.types.create_client_vpn_endpoint_request.CreateClientVpnEndpointRequest = {}
    if client_cidr_block is not None:
        input_["client_cidr_block"] = client_cidr_block
    if server_certificate_arn is not None:
        input_["server_certificate_arn"] = server_certificate_arn
    if authentication_options is not None:
        input_["authentication_options"] = authentication_options
    if connection_log_options is not None:
        input_["connection_log_options"] = connection_log_options
    if dns_servers is not None:
        input_["dns_servers"] = dns_servers
    if transport_protocol is not None:
        input_["transport_protocol"] = transport_protocol
    if vpn_port is not None:
        input_["vpn_port"] = vpn_port
    if description is not None:
        input_["description"] = description
    if split_tunnel is not None:
        input_["split_tunnel"] = split_tunnel
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if security_group_ids is not None:
        input_["security_group_ids"] = security_group_ids
    if vpc_id is not None:
        input_["vpc_id"] = vpc_id
    if self_service_portal is not None:
        input_["self_service_portal"] = self_service_portal
    if client_connect_options is not None:
        input_["client_connect_options"] = client_connect_options
    if session_timeout_hours is not None:
        input_["session_timeout_hours"] = session_timeout_hours
    if client_login_banner_options is not None:
        input_["client_login_banner_options"] = client_login_banner_options
    if client_route_enforcement_options is not None:
        input_["client_route_enforcement_options"] = (
            client_route_enforcement_options
        )
    if disconnect_on_session_timeout is not None:
        input_["disconnect_on_session_timeout"] = disconnect_on_session_timeout
    if endpoint_ip_address_type is not None:
        input_["endpoint_ip_address_type"] = endpoint_ip_address_type
    if traffic_ip_address_type is not None:
        input_["traffic_ip_address_type"] = traffic_ip_address_type
    if transit_gateway_configuration is not None:
        input_["transit_gateway_configuration"] = transit_gateway_configuration
    if device_posture_options is not None:
        input_["device_posture_options"] = device_posture_options

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output