Skip to content
v2.275.0

CfnClientVpnAuthorizationRuleProps Struct ​

Properties for defining a CfnClientVpnAuthorizationRule.

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';
const cfnClientVpnAuthorizationRuleProps: ec2.CfnClientVpnAuthorizationRuleProps = {
  clientVpnEndpointId: 'clientVpnEndpointId',
  targetNetworkCidr: 'targetNetworkCidr',

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

Properties ​

accessGroupIdoptionalstringaccess_group_idoptionalstraccessGroupIdoptionalStringAccessGroupIdoptionalstringAccessGroupIdoptional*string#
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.

authorizeAllGroupsoptionalboolean | IResolvableauthorize_all_groupsoptionaltyping.Union[bool, IResolvable]authorizeAllGroupsoptionalBooleanAuthorizeAllGroupsoptionalboolAuthorizeAllGroupsoptionalinterface{}#
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.

clientVpnEndpointIdstringclient_vpn_endpoint_idstrclientVpnEndpointIdStringClientVpnEndpointIdstringClientVpnEndpointId*stringrequired#
The ID of the Client VPN endpoint.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A brief description of the authorization rule.
targetNetworkCidrstringtarget_network_cidrstrtargetNetworkCidrStringTargetNetworkCidrstringTargetNetworkCidr*stringrequired#
The IPv4 address range, in CIDR notation, of the network for which access is being authorized.