You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::AuthorizeClientVpnIngressRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AuthorizeClientVpnIngressRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  target_network_cidr: "String", # required
  access_group_id: "String",
  authorize_all_groups: false,
  description: "String",
  client_token: "String",
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_group_id ⇒ String

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.

Returns:

  • (String) —

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

#authorize_all_groups ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Indicates whether to grant access to all clients.

#client_token ⇒ String

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

Returns:

  • (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

#client_vpn_endpoint_id ⇒ String

The ID of the Client VPN endpoint.

Returns:

  • (String) —

    The ID of the Client VPN endpoint.

#description ⇒ String

A brief description of the authorization rule.

Returns:

  • (String) —

    A brief description of the authorization rule.

#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.

Returns:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#target_network_cidr ⇒ String

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

Returns:

  • (String) —

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