[ aws . ec2 ]

revoke-client-vpn-ingress

Description

Removes an ingress authorization rule from a Client VPN endpoint.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  revoke-client-vpn-ingress
--client-vpn-endpoint-id <value>
--target-network-cidr <value>
[--access-group-id <value>]
[--revoke-all-groups | --no-revoke-all-groups]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-vpn-endpoint-id (string)

The ID of the Client VPN endpoint with which the authorization rule is associated.

--target-network-cidr (string)

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

--access-group-id (string)

The ID of the Active Directory group for which to revoke access.

--revoke-all-groups | --no-revoke-all-groups (boolean)

Indicates whether access should be revoked for all clients.

--dry-run | --no-dry-run (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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To revoke an authorization rule for a Client VPN endpoint

The following revoke-client-vpn-ingress example revokes a rule for internet access (0.0.0.0/0) for all groups.

aws ec2 revoke-client-vpn-ingress \
    --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \
    --target-network-cidr 0.0.0.0/0 --revoke-all-groups

Output:

{
    "Status": {
        "Code": "revoking"
    }
}

For more information, see Authorization Rules in the AWS Client VPN Administrator Guide.

Output

Status -> (structure)

The current state of the authorization rule.

Code -> (string)

The state of the authorization rule.

Message -> (string)

A message about the status of the authorization rule, if applicable.