2.182.0

interface CfnClientVpnAuthorizationRuleProps

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnClientVpnAuthorizationRuleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnClientVpnAuthorizationRuleProps
Javasoftware.amazon.awscdk.services.ec2.CfnClientVpnAuthorizationRuleProps
Pythonaws_cdk.aws_ec2.CfnClientVpnAuthorizationRuleProps
TypeScript aws-cdk-lib » aws_ec2 » CfnClientVpnAuthorizationRuleProps

Properties for defining a CfnClientVpnAuthorizationRule.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnClientVpnAuthorizationRuleProps: ec2.CfnClientVpnAuthorizationRuleProps = {
  clientVpnEndpointId: 'clientVpnEndpointId',
  targetNetworkCidr: 'targetNetworkCidr',

  // the properties below are optional
  accessGroupId: 'accessGroupId',
  authorizeAllGroups: false,
  description: 'description',
};

Properties

NameTypeDescription
clientVpnEndpointIdstringThe ID of the Client VPN endpoint.
targetNetworkCidrstringThe IPv4 address range, in CIDR notation, of the network for which access is being authorized.
accessGroupId?stringThe ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
authorizeAllGroups?boolean | IResolvableIndicates whether to grant access to all clients.
description?stringA brief description of the authorization rule.

clientVpnEndpointId

Type: string

The ID of the Client VPN endpoint.

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

targetNetworkCidr

Type: string

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

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

accessGroupId?

Type: string (optional)

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

Required if AuthorizeAllGroups is false or not specified.

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

authorizeAllGroups?

Type: boolean | IResolvable (optional)

Indicates whether to grant access to all clients.

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnauthorizationrule.html#cfn-ec2-clientvpnauthorizationrule-authorizeallgroups

description?

Type: string (optional)

A brief description of the authorization rule.

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

← PreviousNext →