ClientVpnAuthorizationRuleProps

class aws_cdk.aws_ec2.ClientVpnAuthorizationRuleProps(*, cidr, description=None, group_id=None, client_vpn_endoint=None, client_vpn_endpoint=None)

Bases: aws_cdk.aws_ec2.ClientVpnAuthorizationRuleOptions

Properties for a ClientVpnAuthorizationRule.

Parameters
  • cidr (str) – The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

  • description (Optional[str]) – A brief description of the authorization rule. Default: - no description

  • group_id (Optional[str]) – The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Default: - authorize all groups

  • client_vpn_endoint (Optional[IClientVpnEndpoint]) – (deprecated) The client VPN endpoint to which to add the rule. Default: clientVpnEndpoint is required

  • client_vpn_endpoint (Optional[IClientVpnEndpoint]) – The client VPN endpoint to which to add the rule. Default: clientVpnEndpoint is required

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

# client_vpn_endpoint is of type ClientVpnEndpoint

client_vpn_authorization_rule_props = ec2.ClientVpnAuthorizationRuleProps(
    cidr="cidr",

    # the properties below are optional
    client_vpn_endoint=client_vpn_endpoint,
    client_vpn_endpoint=client_vpn_endpoint,
    description="description",
    group_id="groupId"
)

Attributes

cidr

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

Return type

str

client_vpn_endoint

(deprecated) The client VPN endpoint to which to add the rule.

Default

clientVpnEndpoint is required

Deprecated

Use clientVpnEndpoint instead

Stability

deprecated

Return type

Optional[IClientVpnEndpoint]

client_vpn_endpoint

The client VPN endpoint to which to add the rule.

Default

clientVpnEndpoint is required

Return type

Optional[IClientVpnEndpoint]

description

A brief description of the authorization rule.

Default
  • no description

Return type

Optional[str]

group_id

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

Default
  • authorize all groups

Return type

Optional[str]