AWS CDK Reference

Appearance

v2.275.0

ClientVpnAuthorizationRuleOptions Struct ​

Options for a ClientVpnAuthorizationRule.

Source
aws-ec2/lib/client-vpn-authorization-rule.ts

Example ​

ts
const endpoint = vpc.addClientVpnEndpoint('Endpoint', {
  cidr: '10.100.0.0/16',
  serverCertificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id',
  userBasedAuthentication: ec2.ClientVpnUserBasedAuthentication.federated(samlProvider),
  authorizeAllUsersToVpcCidr: false,
});

endpoint.addAuthorizationRule('Rule', {
  cidr: '10.0.10.0/32',
  groupId: 'group-id',
});

Properties ​

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

Default: no description

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

Default: authorize all groups