Class CfnClientVpnAuthorizationRule

Specifies an ingress authorization rule to add to a Client VPN endpoint.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnClientVpnAuthorizationRule
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnClientVpnAuthorizationRule : CfnResource, IInspectable
Syntax (vb)
Public Class CfnClientVpnAuthorizationRule
    Inherits CfnResource
    Implements IInspectable
Remarks

Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.

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

CloudformationResource: AWS::EC2::ClientVpnAuthorizationRule

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 cfnClientVpnAuthorizationRule = new CfnClientVpnAuthorizationRule(this, "MyCfnClientVpnAuthorizationRule", new CfnClientVpnAuthorizationRuleProps {
    ClientVpnEndpointId = "clientVpnEndpointId",
    TargetNetworkCidr = "targetNetworkCidr",

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

Synopsis

Constructors

CfnClientVpnAuthorizationRule(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnClientVpnAuthorizationRule(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnClientVpnAuthorizationRule(Construct, String, ICfnClientVpnAuthorizationRuleProps)

Properties

AccessGroupId

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

Indicates whether to grant access to all clients.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnClientVpnAuthorizationRule(ByRefValue)

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

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

The Javascript-owned object reference

CfnClientVpnAuthorizationRule(DeputyBase.DeputyProps)

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

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

The deputy props

CfnClientVpnAuthorizationRule(Construct, String, ICfnClientVpnAuthorizationRuleProps)

public CfnClientVpnAuthorizationRule(Construct scope, string id, ICfnClientVpnAuthorizationRuleProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnClientVpnAuthorizationRuleProps

Resource properties.

Properties

AccessGroupId

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

public virtual string AccessGroupId { get; set; }
Property Value

System.String

AttrId

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

AuthorizeAllGroups

Indicates whether to grant access to all clients.

public virtual object AuthorizeAllGroups { get; set; }
Property Value

System.Object

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

ClientVpnEndpointId

The ID of the Client VPN endpoint.

public virtual string ClientVpnEndpointId { get; set; }
Property Value

System.String

Description

A brief description of the authorization rule.

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

System.String

TargetNetworkCidr

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

public virtual string TargetNetworkCidr { get; set; }
Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements