Class ClientVpnUserBasedAuthentication

User-based authentication for a client VPN endpoint.

Inheritance
object
ClientVpnUserBasedAuthentication
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public abstract class ClientVpnUserBasedAuthentication : DeputyBase
Syntax (vb)
Public MustInherit Class ClientVpnUserBasedAuthentication Inherits DeputyBase
Remarks

ExampleMetadata: fixture=client-vpn infused

Examples
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"
            });

Synopsis

Constructors

ClientVpnUserBasedAuthentication()

User-based authentication for a client VPN endpoint.

Methods

ActiveDirectory(string)

Active Directory authentication.
Federated(ISAMLProviderRef, ISAMLProviderRef?)

Federated authentication.
Render()

Renders the user based authentication.

Constructors

ClientVpnUserBasedAuthentication()

User-based authentication for a client VPN endpoint.

protected ClientVpnUserBasedAuthentication()
Remarks

ExampleMetadata: fixture=client-vpn infused

Examples
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"
            });

Methods

ActiveDirectory(string)

Active Directory authentication.

public static ClientVpnUserBasedAuthentication ActiveDirectory(string directoryId)
Parameters
directoryId string
Returns

ClientVpnUserBasedAuthentication

Remarks

ExampleMetadata: fixture=client-vpn infused

Federated(ISAMLProviderRef, ISAMLProviderRef?)

Federated authentication.

public static ClientVpnUserBasedAuthentication Federated(ISAMLProviderRef samlProvider, ISAMLProviderRef? selfServiceSamlProvider = null)
Parameters
samlProvider ISAMLProviderRef
selfServiceSamlProvider ISAMLProviderRef
Returns

ClientVpnUserBasedAuthentication

Remarks

ExampleMetadata: fixture=client-vpn infused

Render()

Renders the user based authentication.

public abstract object Render()
Returns

object

Remarks

ExampleMetadata: fixture=client-vpn infused