Class CfnClientVpnAuthorizationRuleProps

Properties for defining a CfnClientVpnAuthorizationRule.

Inheritance

object

CfnClientVpnAuthorizationRuleProps

Implements

ICfnClientVpnAuthorizationRuleProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnClientVpnAuthorizationRuleProps : ICfnClientVpnAuthorizationRuleProps

Syntax (vb)

Public Class CfnClientVpnAuthorizationRuleProps Implements ICfnClientVpnAuthorizationRuleProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnClientVpnAuthorizationRuleProps = new CfnClientVpnAuthorizationRuleProps {
                 ClientVpnEndpointId = "clientVpnEndpointId",
                 TargetNetworkCidr = "targetNetworkCidr",

                 // the properties below are optional
                 AccessGroupId = "accessGroupId",
                 AuthorizeAllGroups = false,
                 Description = "description"
             };

Synopsis

Constructors

CfnClientVpnAuthorizationRuleProps()

Properties for defining a CfnClientVpnAuthorizationRule.

Properties

AccessGroupId	The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
AuthorizeAllGroups	Indicates whether to grant access to all clients.
ClientVpnEndpointId	The ID of the Client VPN endpoint.
Description	A brief description of the authorization rule.
TargetNetworkCidr	The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

Constructors

CfnClientVpnAuthorizationRuleProps()

Properties for defining a CfnClientVpnAuthorizationRule.

public CfnClientVpnAuthorizationRuleProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnClientVpnAuthorizationRuleProps = new CfnClientVpnAuthorizationRuleProps {
                 ClientVpnEndpointId = "clientVpnEndpointId",
                 TargetNetworkCidr = "targetNetworkCidr",

                 // the properties below are optional
                 AccessGroupId = "accessGroupId",
                 AuthorizeAllGroups = false,
                 Description = "description"
             };

Properties

AccessGroupId

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

public string? AccessGroupId { get; set; }

Property Value

string

Remarks

Required if AuthorizeAllGroups is false or not specified.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-accessgroupid

AuthorizeAllGroups

Indicates whether to grant access to all clients.

public object? AuthorizeAllGroups { get; set; }

Property Value

object

Remarks

Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-authorizeallgroups

Type union: either bool or IResolvable

ClientVpnEndpointId

The ID of the Client VPN endpoint.

public string ClientVpnEndpointId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-clientvpnendpointid

Description

A brief description of the authorization rule.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-description

TargetNetworkCidr

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

public string TargetNetworkCidr { get; set; }