software.amazon.awscdk.services.ec2

Interface ClientVpnEndpointProps

All Superinterfaces:

ClientVpnEndpointOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClientVpnEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.404Z")
 @Stability(value=Stable)
public interface ClientVpnEndpointProps
extends software.amazon.jsii.JsiiSerializable, ClientVpnEndpointOptions

Properties for a client VPN endpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.logs.*;
 IClientVpnConnectionHandler clientVpnConnectionHandler;
 ClientVpnUserBasedAuthentication clientVpnUserBasedAuthentication;
 LogGroup logGroup;
 LogStream logStream;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Vpc vpc;
 ClientVpnEndpointProps clientVpnEndpointProps = ClientVpnEndpointProps.builder()
         .cidr("cidr")
         .serverCertificateArn("serverCertificateArn")
         .vpc(vpc)
         // the properties below are optional
         .authorizeAllUsersToVpcCidr(false)
         .clientCertificateArn("clientCertificateArn")
         .clientConnectionHandler(clientVpnConnectionHandler)
         .clientLoginBanner("clientLoginBanner")
         .description("description")
         .dnsServers(List.of("dnsServers"))
         .logging(false)
         .logGroup(logGroup)
         .logStream(logStream)
         .port(VpnPort.HTTPS)
         .securityGroups(List.of(securityGroup))
         .selfServicePortal(false)
         .sessionTimeout(ClientVpnSessionTimeout.EIGHT_HOURS)
         .splitTunnel(false)
         .transportProtocol(TransportProtocol.TCP)
         .userBasedAuthentication(clientVpnUserBasedAuthentication)
         .vpcSubnets(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClientVpnEndpointProps.Builder A builder for ClientVpnEndpointProps
static class	ClientVpnEndpointProps.Jsii$Proxy An implementation for ClientVpnEndpointProps

Method Summary

Modifier and Type	Method and Description
static ClientVpnEndpointProps.Builder	builder()
IVpc	getVpc() The VPC to connect to.

Methods inherited from interface software.amazon.awscdk.services.ec2.ClientVpnEndpointOptions

getAuthorizeAllUsersToVpcCidr, getCidr, getClientCertificateArn, getClientConnectionHandler, getClientLoginBanner, getDescription, getDnsServers, getLogging, getLogGroup, getLogStream, getPort, getSecurityGroups, getSelfServicePortal, getServerCertificateArn, getSessionTimeout, getSplitTunnel, getTransportProtocol, getUserBasedAuthentication, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getVpc

@Stability(value=Stable)
 @NotNull
IVpc getVpc()

The VPC to connect to.

builder

@Stability(value=Stable)
static ClientVpnEndpointProps.Builder builder()

Specified by:

builder in interface ClientVpnEndpointOptions

Returns:

a ClientVpnEndpointProps.Builder of ClientVpnEndpointProps