/AWS1/IF_EC2=>AUTHORIZECLIENTVPNINGRESS()

About AuthorizeClientVpnIngress

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 Amazon Web Services or on-premises networks.

Method Signature

METHODS /AWS1/IF_EC2~AUTHORIZECLIENTVPNINGRESS
  IMPORTING
    !IV_CLIENTVPNENDPOINTID TYPE /AWS1/EC2CLIENTVPNENDPOINTID OPTIONAL
    !IV_TARGETNETWORKCIDR TYPE /AWS1/EC2STRING OPTIONAL
    !IV_ACCESSGROUPID TYPE /AWS1/EC2STRING OPTIONAL
    !IV_AUTHORIZEALLGROUPS TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/EC2STRING OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2authclivpningrslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_clientvpnendpointid TYPE /AWS1/EC2CLIENTVPNENDPOINTID /AWS1/EC2CLIENTVPNENDPOINTID

The ID of the Client VPN endpoint.

iv_targetnetworkcidr TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

Optional arguments:

iv_accessgroupid TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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.

iv_authorizeallgroups TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

iv_description TYPE /AWS1/EC2STRING /AWS1/EC2STRING

A brief description of the authorization rule.

iv_clienttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2authclivpningrslt /AWS1/CL_EC2AUTHCLIVPNINGRSLT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->authorizeclientvpningress(
  iv_accessgroupid = |string|
  iv_authorizeallgroups = ABAP_TRUE
  iv_clienttoken = |string|
  iv_clientvpnendpointid = |string|
  iv_description = |string|
  iv_dryrun = ABAP_TRUE
  iv_targetnetworkcidr = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_clientvpnauthorizationr = lo_result->get_status( ).
  IF lo_clientvpnauthorizationr IS NOT INITIAL.
    lv_clientvpnauthorizationr_1 = lo_clientvpnauthorizationr->get_code( ).
    lv_string = lo_clientvpnauthorizationr->get_message( ).
  ENDIF.
ENDIF.