Skip to content
v2.273.0

ClientVpnAuthorizationRuleProps Struct ​

Properties for a ClientVpnAuthorizationRule.

Example ​

ts
// 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';
import { aws_ec2 as interfaces_ec2 } from 'aws-cdk-lib/interfaces';

declare const clientVpnEndpointRef: interfaces_ec2.IClientVpnEndpointRef;
const clientVpnAuthorizationRuleProps: ec2.ClientVpnAuthorizationRuleProps = {
  cidr: 'cidr',

  // the properties below are optional
  clientVpnEndpoint: clientVpnEndpointRef,
  description: 'description',
  groupId: 'groupId',
};

Properties ​

cidrstringcidrstrcidrStringCidrstringCidr*stringrequired#
The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
clientVpnEndpointIClientVpnEndpointRefclient_vpn_endpointIClientVpnEndpointRefclientVpnEndpointIClientVpnEndpointRefClientVpnEndpointIClientVpnEndpointRefClientVpnEndpointIClientVpnEndpointRef= clientVpnEndpoint is required#
The client VPN endpoint to which to add the rule.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#
A brief description of the authorization rule.
groupIdstringgroup_idstrgroupIdStringGroupIdstringGroupId*string= authorize all groups#
The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.

Used as props by ​