AuthorizeClientVpnIngress - Amazon Elastic Compute Cloud


Adds an ingress authorization rule 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.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.


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.

Type: String

Required: No


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.

Type: Boolean

Required: No


Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Type: String

Required: No


The ID of the Client VPN endpoint.

Type: String

Required: Yes


A brief description of the authorization rule.

Type: String

Required: No


Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No


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

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.


The ID of the request.

Type: String


The current state of the authorization rule.

Type: ClientVpnAuthorizationRuleStatus object


For information about the errors that are common to all actions, see Common client error codes.



This example adds an authorization rule to a subnet and grants access to all users.

Sample Request &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &TargetNetworkCidr= &AuthorizeAllGroups=true &AUTHPARAMS

Sample Response

<AuthorizeClientVpnIngressResponse xmlns=""> <requestId>afafad8c-274c-4584-bbd1-75a21EXAMPLE</requestId> <status> <code>authorizing</code> </status> </AuthorizeClientVpnIngressResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: