CfnClientVpnAuthorizationRuleProps¶
-
class
aws_cdk.aws_ec2.
CfnClientVpnAuthorizationRuleProps
(*, client_vpn_endpoint_id, target_network_cidr, access_group_id=None, authorize_all_groups=None, description=None)¶ Bases:
object
Properties for defining a
CfnClientVpnAuthorizationRule
.- Parameters
client_vpn_endpoint_id (
str
) – The ID of the Client VPN endpoint.target_network_cidr (
str
) – The IPv4 address range, in CIDR notation, of the network for which access is being authorized.access_group_id (
Optional
[str
]) – The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required ifAuthorizeAllGroups
isfalse
or not specified.authorize_all_groups (
Union
[bool
,IResolvable
,None
]) – Indicates whether to grant access to all clients. Specifytrue
to grant all clients who successfully establish a VPN connection access to the network. Must be set totrue
ifAccessGroupId
is not specified.description (
Optional
[str
]) – A brief description of the authorization rule.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ec2 as ec2 cfn_client_vpn_authorization_rule_props = ec2.CfnClientVpnAuthorizationRuleProps( client_vpn_endpoint_id="clientVpnEndpointId", target_network_cidr="targetNetworkCidr", # the properties below are optional access_group_id="accessGroupId", authorize_all_groups=False, description="description" )
Attributes
-
access_group_id
¶ The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
Required if
AuthorizeAllGroups
isfalse
or not specified.
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 totrue
ifAccessGroupId
is not specified.
-
client_vpn_endpoint_id
¶ The ID of the Client VPN endpoint.
-
description
¶ A brief description of the authorization rule.
-
target_network_cidr
¶ The IPv4 address range, in CIDR notation, of the network for which access is being authorized.