AWS::EC2::ClientVpnAuthorizationRule - AWS CloudFormation
SyntaxPropertiesExamplesSee also

AWS::EC2::ClientVpnAuthorizationRule

Specifies an ingress authorization rule to add to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::ClientVpnAuthorizationRule",
  "Properties" : {
      "AccessGroupId" : String,
      "AuthorizeAllGroups" : Boolean,
      "ClientVpnEndpointId" : String,
      "Description" : String,
      "TargetNetworkCidr" : String
    }
}

YAML

Type: AWS::EC2::ClientVpnAuthorizationRule
Properties:
  AccessGroupId: String
  AuthorizeAllGroups: Boolean
  ClientVpnEndpointId: String
  Description: String
  TargetNetworkCidr: String

Properties

AccessGroupId

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.

Required: No

Type: String

Update requires: Replacement

AuthorizeAllGroups

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.

Required: No

Type: Boolean

Update requires: Replacement

ClientVpnEndpointId

The ID of the Client VPN endpoint.

Required: Yes

Type: String

Update requires: Replacement

Description

A brief description of the authorization rule.

Required: No

Type: String

Update requires: Replacement

TargetNetworkCidr

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

Required: Yes

Type: String

Update requires: Replacement

Examples

Add an authorization rule to a client VPN endpoint

The following example adds an authorization rule that grants all users access to the internet.

YAML

myAuthRule:
  Type: "AWS::EC2::ClientVpnAuthorizationRule"
  Properties:
    ClientVpnEndpointId: 
      Ref: myClientVpnEndpoint
    AuthorizeAllGroups: true
    TargetNetworkCidr: "0.0.0.0/0"
    Description: "myAuthRule"

JSON

"myAuthRule": {
    "Type": "AWS::EC2::ClientVpnAuthorizationRule",
    "Properties": {
        "ClientVpnEndpointId": {
            "Ref": "myClientVpnEndpoint"
        },
        "AuthorizeAllGroups": true,
        "TargetNetworkCidr": "0.0.0.0/0",
        "Description": "myAuthRule"
    }
}

See also