Show / Hide Table of Contents

Class ClientVpnEndpoint

A client VPN connnection.

Inheritance
System.Object
Construct
Resource
ClientVpnEndpoint
Implements
IClientVpnEndpoint
IResource
IConstruct
Constructs.IConstruct
IDependable
IConnectable
Inherited Members
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(String, IArnComponents)
Resource.GetResourceNameAttribute(String)
Resource.Env
Resource.PhysicalName
Resource.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class ClientVpnEndpoint : Resource, IClientVpnEndpoint, IResource, IConstruct, IDependable, IConnectable
Syntax (vb)
Public Class ClientVpnEndpoint
    Inherits Resource
    Implements IClientVpnEndpoint, IResource, IConstruct, IDependable, IConnectable
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

ClientVpnEndpoint(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

ClientVpnEndpoint(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

ClientVpnEndpoint(Construct, String, IClientVpnEndpointProps)

Properties

Connections

Allows specify security group connections for the endpoint.

EndpointId

The endpoint ID.

TargetNetworksAssociated

Dependable that can be depended upon to force target networks associations.

Methods

AddAuthorizationRule(String, IClientVpnAuthorizationRuleOptions)

Adds an authorization rule to this endpoint.

AddRoute(String, IClientVpnRouteOptions)

Adds a route to this endpoint.

FromEndpointAttributes(Construct, String, IClientVpnEndpointAttributes)

Import an existing client VPN endpoint.

Constructors

ClientVpnEndpoint(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected ClientVpnEndpoint(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

ClientVpnEndpoint(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected ClientVpnEndpoint(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

ClientVpnEndpoint(Construct, String, IClientVpnEndpointProps)

public ClientVpnEndpoint(Construct scope, string id, IClientVpnEndpointProps props)
Parameters
scope Constructs.Construct
id System.String
props IClientVpnEndpointProps

Properties

Connections

Allows specify security group connections for the endpoint.

public virtual Connections_ Connections { get; }
Property Value

Connections_

EndpointId

The endpoint ID.

public virtual string EndpointId { get; }
Property Value

System.String

TargetNetworksAssociated

Dependable that can be depended upon to force target networks associations.

public virtual IDependable TargetNetworksAssociated { get; }
Property Value

IDependable

Methods

AddAuthorizationRule(String, IClientVpnAuthorizationRuleOptions)

Adds an authorization rule to this endpoint.

public virtual ClientVpnAuthorizationRule AddAuthorizationRule(string id, IClientVpnAuthorizationRuleOptions props)
Parameters
id System.String
props IClientVpnAuthorizationRuleOptions
Returns

ClientVpnAuthorizationRule

AddRoute(String, IClientVpnRouteOptions)

Adds a route to this endpoint.

public virtual ClientVpnRoute AddRoute(string id, IClientVpnRouteOptions props)
Parameters
id System.String
props IClientVpnRouteOptions
Returns

ClientVpnRoute

FromEndpointAttributes(Construct, String, IClientVpnEndpointAttributes)

Import an existing client VPN endpoint.

public static IClientVpnEndpoint FromEndpointAttributes(Construct scope, string id, IClientVpnEndpointAttributes attrs)
Parameters
scope Constructs.Construct
id System.String
attrs IClientVpnEndpointAttributes
Returns

IClientVpnEndpoint

Implements

IClientVpnEndpoint
IResource
IConstruct
Constructs.IConstruct
IDependable
IConnectable
Back to top Generated by DocFX