AWS CDK Reference

Appearance

v2.274.0

ClientVpnUserBasedAuthentication Class ​

User-based authentication for a client VPN endpoint.

Source
aws-ec2/lib/client-vpn-endpoint.ts
Type last changed
v2.224.0 · 13 Nov 2025

Example ​

ts
const endpoint = vpc.addClientVpnEndpoint('Endpoint', {
  cidr: '10.100.0.0/16',
  serverCertificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id',
  userBasedAuthentication: ec2.ClientVpnUserBasedAuthentication.federated(samlProvider),
  authorizeAllUsersToVpcCidr: false,
});

endpoint.addAuthorizationRule('Rule', {
  cidr: '10.0.10.0/32',
  groupId: 'group-id',
});

Initializer ​

ts
new ClientVpnUserBasedAuthentication()
python
ClientVpnUserBasedAuthentication()
java
new ClientVpnUserBasedAuthentication()
csharp
new ClientVpnUserBasedAuthentication()
go
NewClientVpnUserBasedAuthentication()

Methods ​

activeDirectory(directoryId: string): ClientVpnUserBasedAuthentication // chainable@staticmethod def active_directory(directory_id: str) -> ClientVpnUserBasedAuthenticationpublic static ClientVpnUserBasedAuthentication activeDirectory(String directoryId)public static ClientVpnUserBasedAuthentication ActiveDirectory(string directoryId)func ActiveDirectory(DirectoryId *string) ClientVpnUserBasedAuthenticationstatic#
Active Directory authentication.
federated(samlProvider: ISAMLProviderRef, selfServiceSamlProvider?: ISAMLProviderRef): ClientVpnUserBasedAuthentication // chainable@staticmethod def federated(saml_provider: ISAMLProviderRef, self_service_saml_provider: typing.Optional[ISAMLProviderRef] = None) -> ClientVpnUserBasedAuthenticationpublic static ClientVpnUserBasedAuthentication federated(ISAMLProviderRef samlProvider, ISAMLProviderRef selfServiceSamlProvider)public static ClientVpnUserBasedAuthentication Federated(ISAMLProviderRef samlProvider, ISAMLProviderRef? selfServiceSamlProvider = null)func Federated(SamlProvider ISAMLProviderRef, SelfServiceSamlProvider ISAMLProviderRef) ClientVpnUserBasedAuthenticationstatic#
Federated authentication.
render(): anydef render(self, ) -> Anypublic Object render()public object Render()func Render() interface{}#
Renders the user based authentication.