Class CfnClientVpnAuthorizationRule
A CloudFormation AWS::EC2::ClientVpnAuthorizationRule
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnClientVpnAuthorizationRule : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnClientVpnAuthorizationRule
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies an ingress authorization rule to add to a Client VPN endpoint. 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.
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(Construct, String, ICfnClientVpnAuthorizationRuleProps) | Create a new |
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 |
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. |
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(Construct, String, ICfnClientVpnAuthorizationRuleProps)
Create a new AWS::EC2::ClientVpnAuthorizationRule
.
public CfnClientVpnAuthorizationRule(Construct scope, string id, ICfnClientVpnAuthorizationRuleProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnClientVpnAuthorizationRuleProps
- resource properties.
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
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
Remarks
Required if AuthorizeAllGroups
is false
or not specified.
AuthorizeAllGroups
Indicates whether to grant access to all clients.
public virtual object AuthorizeAllGroups { get; set; }
Property Value
System.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.
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
Remarks
Description
A brief description of the authorization rule.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
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
Remarks
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>