Interface ClientVpnEndpointProps
- All Superinterfaces:
ClientVpnEndpointOptions,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
ClientVpnEndpointProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-12-01T16:02:19.365Z")
@Stability(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")
.clientRouteEnforcementOptions(ClientRouteEnforcementOptions.builder()
.enforced(false)
.build())
.description("description")
.disconnectOnSessionTimeout(false)
.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 ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forClientVpnEndpointPropsstatic final classAn implementation forClientVpnEndpointProps -
Method Summary
Methods inherited from interface software.amazon.awscdk.services.ec2.ClientVpnEndpointOptions
getAuthorizeAllUsersToVpcCidr, getCidr, getClientCertificateArn, getClientConnectionHandler, getClientLoginBanner, getClientRouteEnforcementOptions, getDescription, getDisconnectOnSessionTimeout, getDnsServers, getLogging, getLogGroup, getLogStream, getPort, getSecurityGroups, getSelfServicePortal, getServerCertificateArn, getSessionTimeout, getSplitTunnel, getTransportProtocol, getUserBasedAuthentication, getVpcSubnetsMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getVpc
The VPC to connect to. -
builder
- Returns:
- a
ClientVpnEndpointProps.BuilderofClientVpnEndpointProps
-