aws-cdk-lib.aws_ec2.ClientVpnUserBasedAuthentication

class ClientVpnUserBasedAuthentication

LanguageType name
.NETAmazon.CDK.AWS.EC2.ClientVpnUserBasedAuthentication
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#ClientVpnUserBasedAuthentication
Javasoftware.amazon.awscdk.services.ec2.ClientVpnUserBasedAuthentication
Pythonaws_cdk.aws_ec2.ClientVpnUserBasedAuthentication
TypeScript (source)aws-cdk-lib » aws_ec2 » ClientVpnUserBasedAuthentication

User-based authentication for a client VPN endpoint.

Example

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

new ClientVpnUserBasedAuthentication()

Methods

NameDescription
render()Renders the user based authentication.
static activeDirectory(directoryId)Active Directory authentication.
static federated(samlProvider, selfServiceSamlProvider?)Federated authentication.

render()

public render(): any

Returns

  • any

Renders the user based authentication.


static activeDirectory(directoryId)

public static activeDirectory(directoryId: string): ClientVpnUserBasedAuthentication

Parameters

  • directoryId string

Returns

  • ClientVpnUserBasedAuthentication

Active Directory authentication.


static federated(samlProvider, selfServiceSamlProvider?)

public static federated(samlProvider: ISamlProvider, selfServiceSamlProvider?: ISamlProvider): ClientVpnUserBasedAuthentication

Parameters

  • samlProvider ISamlProvider
  • selfServiceSamlProvider ISamlProvider

Returns

  • ClientVpnUserBasedAuthentication

Federated authentication.