Class ClientVpnAuthorizationRuleOptions

Options for a ClientVpnAuthorizationRule.

Inheritance
object
ClientVpnAuthorizationRuleOptions
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ClientVpnAuthorizationRuleOptions : IClientVpnAuthorizationRuleOptions
Syntax (vb)
Public Class ClientVpnAuthorizationRuleOptions Implements IClientVpnAuthorizationRuleOptions
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

ClientVpnAuthorizationRuleOptions()

Options for a ClientVpnAuthorizationRule.

Properties

Cidr

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
Description

A brief description of the authorization rule.
GroupId

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.

Constructors

ClientVpnAuthorizationRuleOptions()

Options for a ClientVpnAuthorizationRule.

public ClientVpnAuthorizationRuleOptions()
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"
            });

Properties

Cidr

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

public string Cidr { get; set; }
Property Value

string

Remarks

ExampleMetadata: fixture=client-vpn infused

Description

A brief description of the authorization rule.

public string? Description { get; set; }
Property Value

string

Remarks

Default: - no description

GroupId

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.

public string? GroupId { get; set; }
Property Value

string

Remarks

Default: - authorize all groups

Implements