Skip to content

/AWS1/IF_NWF=>UPDATEPROXYRULE()

About UpdateProxyRule

Updates the properties of the specified proxy rule.

Method Signature

METHODS /AWS1/IF_NWF~UPDATEPROXYRULE
  IMPORTING
    !IV_PROXYRULEGROUPNAME TYPE /AWS1/NWFRESOURCENAME OPTIONAL
    !IV_PROXYRULEGROUPARN TYPE /AWS1/NWFRESOURCEARN OPTIONAL
    !IV_PROXYRULENAME TYPE /AWS1/NWFRESOURCENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/NWFDESCRIPTION OPTIONAL
    !IV_ACTION TYPE /AWS1/NWFPROXYRULEPHASEACTION OPTIONAL
    !IT_ADDCONDITIONS TYPE /AWS1/CL_NWFPROXYRULECONDITION=>TT_PROXYRULECONDITIONLIST OPTIONAL
    !IT_REMOVECONDITIONS TYPE /AWS1/CL_NWFPROXYRULECONDITION=>TT_PROXYRULECONDITIONLIST OPTIONAL
    !IV_UPDATETOKEN TYPE /AWS1/NWFUPDATETOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nwfupdateproxyrulersp
  RAISING
    /AWS1/CX_NWFINTERNALSERVERERR
    /AWS1/CX_NWFINVALIDREQUESTEX
    /AWS1/CX_NWFRESOURCENOTFOUNDEX
    /AWS1/CX_NWFTHROTTLINGEX
    /AWS1/CX_NWFCLIENTEXC
    /AWS1/CX_NWFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_proxyrulename TYPE /AWS1/NWFRESOURCENAME /AWS1/NWFRESOURCENAME

The descriptive name of the proxy rule. You can't change the name of a proxy rule after you create it.

iv_updatetoken TYPE /AWS1/NWFUPDATETOKEN /AWS1/NWFUPDATETOKEN

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

To make changes to the proxy rule, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy rule again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Optional arguments:

iv_proxyrulegroupname TYPE /AWS1/NWFRESOURCENAME /AWS1/NWFRESOURCENAME

The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.

You must specify the ARN or the name, and you can specify both.

iv_proxyrulegrouparn TYPE /AWS1/NWFRESOURCEARN /AWS1/NWFRESOURCEARN

The Amazon Resource Name (ARN) of a proxy rule group.

You must specify the ARN or the name, and you can specify both.

iv_description TYPE /AWS1/NWFDESCRIPTION /AWS1/NWFDESCRIPTION

A description of the proxy rule.

iv_action TYPE /AWS1/NWFPROXYRULEPHASEACTION /AWS1/NWFPROXYRULEPHASEACTION

Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.

it_addconditions TYPE /AWS1/CL_NWFPROXYRULECONDITION=>TT_PROXYRULECONDITIONLIST TT_PROXYRULECONDITIONLIST

Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

it_removeconditions TYPE /AWS1/CL_NWFPROXYRULECONDITION=>TT_PROXYRULECONDITIONLIST TT_PROXYRULECONDITIONLIST

Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

RETURNING

oo_output TYPE REF TO /aws1/cl_nwfupdateproxyrulersp /AWS1/CL_NWFUPDATEPROXYRULERSP

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->updateproxyrule(
  it_addconditions = VALUE /aws1/cl_nwfproxyrulecondition=>tt_proxyruleconditionlist(
    (
      new /aws1/cl_nwfproxyrulecondition(
        it_conditionvalues = VALUE /aws1/cl_nwfproxycondvallist_w=>tt_proxyconditionvaluelist(
          ( new /aws1/cl_nwfproxycondvallist_w( |string| ) )
        )
        iv_conditionkey = |string|
        iv_conditionoperator = |string|
      )
    )
  )
  it_removeconditions = VALUE /aws1/cl_nwfproxyrulecondition=>tt_proxyruleconditionlist(
    (
      new /aws1/cl_nwfproxyrulecondition(
        it_conditionvalues = VALUE /aws1/cl_nwfproxycondvallist_w=>tt_proxyconditionvaluelist(
          ( new /aws1/cl_nwfproxycondvallist_w( |string| ) )
        )
        iv_conditionkey = |string|
        iv_conditionoperator = |string|
      )
    )
  )
  iv_action = |string|
  iv_description = |string|
  iv_proxyrulegrouparn = |string|
  iv_proxyrulegroupname = |string|
  iv_proxyrulename = |string|
  iv_updatetoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_proxyrule = lo_result->get_proxyrule( ).
  IF lo_proxyrule IS NOT INITIAL.
    lv_resourcename = lo_proxyrule->get_proxyrulename( ).
    lv_description = lo_proxyrule->get_description( ).
    lv_proxyrulephaseaction = lo_proxyrule->get_action( ).
    LOOP AT lo_proxyrule->get_conditions( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_conditionoperator = lo_row_1->get_conditionoperator( ).
        lv_conditionkey = lo_row_1->get_conditionkey( ).
        LOOP AT lo_row_1->get_conditionvalues( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_proxyconditionvalue = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
  LOOP AT lo_result->get_removedconditions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_conditionoperator = lo_row_1->get_conditionoperator( ).
      lv_conditionkey = lo_row_1->get_conditionkey( ).
      LOOP AT lo_row_1->get_conditionvalues( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_proxyconditionvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_updatetoken = lo_result->get_updatetoken( ).
ENDIF.