Skip to content
v2.277.0

ClientVpnUserBasedAuthentication Class ​

User-based authentication for a client VPN endpoint.

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',
});
python
endpoint = vpc.add_client_vpn_endpoint("Endpoint",
    cidr="10.100.0.0/16",
    server_certificate_arn="arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id",
    user_based_authentication=ec2.ClientVpnUserBasedAuthentication.federated(saml_provider),
    authorize_all_users_to_vpc_cidr=False
)

endpoint.add_authorization_rule("Rule",
    cidr="10.0.10.0/32",
    group_id="group-id"
)
java
ClientVpnEndpoint endpoint = vpc.addClientVpnEndpoint("Endpoint", ClientVpnEndpointOptions.builder()
        .cidr("10.100.0.0/16")
        .serverCertificateArn("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id")
        .userBasedAuthentication(ClientVpnUserBasedAuthentication.federated(samlProvider))
        .authorizeAllUsersToVpcCidr(false)
        .build());

endpoint.addAuthorizationRule("Rule", ClientVpnAuthorizationRuleOptions.builder()
        .cidr("10.0.10.0/32")
        .groupId("group-id")
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
var endpoint = vpc.AddClientVpnEndpoint("Endpoint", new ClientVpnEndpointOptions {
    Cidr = "10.100.0.0/16",
    ServerCertificateArn = "arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id",
    UserBasedAuthentication = ClientVpnUserBasedAuthentication.Federated(samlProvider),
    AuthorizeAllUsersToVpcCidr = false
});

endpoint.AddAuthorizationRule("Rule", new ClientVpnAuthorizationRuleOptions {
    Cidr = "10.0.10.0/32",
    GroupId = "group-id"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
endpoint := vpc.addClientVpnEndpoint(jsii.String("Endpoint"), &ClientVpnEndpointOptions{
	Cidr: jsii.String("10.100.0.0/16"),
	ServerCertificateArn: jsii.String("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id"),
	UserBasedAuthentication: ec2.ClientVpnUserBasedAuthentication_Federated(samlProvider),
	AuthorizeAllUsersToVpcCidr: jsii.Boolean(false),
})

endpoint.AddAuthorizationRule(jsii.String("Rule"), &ClientVpnAuthorizationRuleOptions{
	Cidr: jsii.String("10.0.10.0/32"),
	GroupId: jsii.String("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) ClientVpnUserBasedAuthentication static #
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) ClientVpnUserBasedAuthentication static #
Federated authentication.
render(): anydef render(self, ) -> Anypublic Object render()public object Render()func Render() interface{} #
Renders the user based authentication.