client_vpn_authorization_rules

Creates, updates, deletes, gets or lists a client_vpn_authorization_rules resource.

Overview

Name	client_vpn_authorization_rules
Type	Resource
Id	aws.ec2.client_vpn_authorization_rules

Fields

The following fields are returned by SELECT queries:

describe_client_vpn_authorization_rules

Name	Datatype	Description
access_all	boolean	Indicates whether the authorization rule grants access to all clients.
client_vpn_endpoint_id	string	The ID of the Client VPN endpoint with which the authorization rule is associated.
description	string	A brief description of the authorization rule.
destination_cidr	string	The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.
group_id	string	The ID of the Active Directory group to which the authorization rule grants access.
status	string	The current state of the authorization rule.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_client_vpn_authorization_rules	select	ClientVpnEndpointId, region	DryRun, NextToken, Filter, MaxResults	Describes the authorization rules for a specified Client VPN endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ClientVpnEndpointId	string	The ID of the Client VPN endpoint.
region	string	AWS region (default: us-east-1)
DryRun	boolean	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.
Filter	array	One or more filters. Filter names and values are case-sensitive. description - The description of the authorization rule. destination-cidr - The CIDR of the network to which the authorization rule applies. group-id - The ID of the Active Directory group to which the authorization rule grants access.
MaxResults	integer	The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
NextToken	string	The token to retrieve the next page of results.

SELECT examples

describe_client_vpn_authorization_rules

Describes the authorization rules for a specified Client VPN endpoint.

SELECT
access_all,
client_vpn_endpoint_id,
description,
destination_cidr,
group_id,
status
FROM aws.ec2.client_vpn_authorization_rules
WHERE ClientVpnEndpointId = '{{ ClientVpnEndpointId }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
;