Skip to content

/AWS1/IF_NWS=>UPDATEPOLICY()

About UpdatePolicy

Updates the specified policy. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the policy as a draft.

Method Signature

METHODS /AWS1/IF_NWS~UPDATEPOLICY
  IMPORTING
    !IV_POLICYIDENTIFIER TYPE /AWS1/NWSPOLICYIDENTIFIER OPTIONAL
    !IV_UPDATETOKEN TYPE /AWS1/NWSUPDATETOKEN OPTIONAL
    !IV_POLICYDESCRIPTION TYPE /AWS1/NWSDESCRIPTION OPTIONAL
    !IV_PRIORITY TYPE /AWS1/NWSPRIORITY OPTIONAL
    !IT_ASSOCTEMPLATEANDRULELIST TYPE /AWS1/CL_NWSTEMPLATEORRULEREF=>TT_TEMPLATEANDRULEREFLIST OPTIONAL
    !IO_POLICYCONFIGURATION TYPE REF TO /AWS1/CL_NWSPOLICYCONF OPTIONAL
    !IV_ISPUBLISHED TYPE /AWS1/NWSISPUBLISHED OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/NWSIDEMPOTENCYTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nwsupdatepolicyoutput
  RAISING
    /AWS1/CX_NWSACCESSDENIEDEX
    /AWS1/CX_NWSCONFLICTEXCEPTION
    /AWS1/CX_NWSINTERNALSERVEREX
    /AWS1/CX_NWSRESOURCENOTFOUNDEX
    /AWS1/CX_NWSSERVICEQUOTAEXCDEX
    /AWS1/CX_NWSTHROTTLINGEX
    /AWS1/CX_NWSVLDTNEXCEPTION
    /AWS1/CX_NWSCLIENTEXC
    /AWS1/CX_NWSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_policyidentifier TYPE /AWS1/NWSPOLICYIDENTIFIER /AWS1/NWSPOLICYIDENTIFIER

The identifier of the policy. This is the policy's Amazon Resource Name (ARN).

iv_updatetoken TYPE /AWS1/NWSUPDATETOKEN /AWS1/NWSUPDATETOKEN

A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

iv_ispublished TYPE /AWS1/NWSISPUBLISHED /AWS1/NWSISPUBLISHED

Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT).

Optional arguments:

iv_policydescription TYPE /AWS1/NWSDESCRIPTION /AWS1/NWSDESCRIPTION

A description of the policy.

iv_priority TYPE /AWS1/NWSPRIORITY /AWS1/NWSPRIORITY

The priority of the resource. A lower number indicates a higher priority.

it_assoctemplateandrulelist TYPE /AWS1/CL_NWSTEMPLATEORRULEREF=>TT_TEMPLATEANDRULEREFLIST TT_TEMPLATEANDRULEREFLIST

The templates and rules to associate with the policy. For AWS WAF policies, specify 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list must be empty.

io_policyconfiguration TYPE REF TO /AWS1/CL_NWSPOLICYCONF /AWS1/CL_NWSPOLICYCONF

The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.

iv_clienttoken TYPE /AWS1/NWSIDEMPOTENCYTOKEN /AWS1/NWSIDEMPOTENCYTOKEN

A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

RETURNING

oo_output TYPE REF TO /aws1/cl_nwsupdatepolicyoutput /AWS1/CL_NWSUPDATEPOLICYOUTPUT

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->updatepolicy(
  io_policyconfiguration = new /aws1/cl_nwspolicyconf(
    io_wafconfig = new /aws1/cl_nwswafconfig(
      iv_conflictresolution = |string|
      iv_exstcustomerwebaclrsln = |string|
    )
    iv_remediationenabled = ABAP_TRUE
    iv_resourcescleanup = ABAP_TRUE
  )
  it_assoctemplateandrulelist = VALUE /aws1/cl_nwstemplateorruleref=>tt_templateandrulereflist(
    (
      new /aws1/cl_nwstemplateorruleref(
        iv_ruleidentifier = |string|
        iv_templateidentifier = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_ispublished = ABAP_TRUE
  iv_policydescription = |string|
  iv_policyidentifier = |string|
  iv_priority = 123
  iv_updatetoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_policyid = lo_result->get_policyid( ).
  lv_policyarn = lo_result->get_policyarn( ).
  lv_policyname = lo_result->get_policyname( ).
  lv_description = lo_result->get_policydescription( ).
  lv_entitystatus = lo_result->get_status( ).
  lv_priority = lo_result->get_priority( ).
  LOOP AT lo_result->get_assoctemplateandrulelist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_templatearn = lo_row_1->get_templatearn( ).
      lv_rulearn = lo_row_1->get_rulearn( ).
    ENDIF.
  ENDLOOP.
  lv_entityversion = lo_result->get_version( ).
  lv_updatetoken = lo_result->get_updatetoken( ).
  lv_issnapshot = lo_result->get_issnapshot( ).
  lv_haspublishedversion = lo_result->get_haspublishedversion( ).
  lv_policyfirewalltype = lo_result->get_firewalltype( ).
  lo_policyconfiguration = lo_result->get_policyconfiguration( ).
  IF lo_policyconfiguration IS NOT INITIAL.
    lv_remediationenabled = lo_policyconfiguration->get_remediationenabled( ).
    lv_resourcescleanup = lo_policyconfiguration->get_resourcescleanup( ).
    lo_wafconfig = lo_policyconfiguration->get_wafconfig( ).
    IF lo_wafconfig IS NOT INITIAL.
      lv_existingcustomerwebaclr = lo_wafconfig->get_exstcustomerwebaclrsln( ).
      lv_wafconflictresolutionop = lo_wafconfig->get_conflictresolution( ).
    ENDIF.
  ENDIF.
  lv_datetimestamp = lo_result->get_updatedat( ).
ENDIF.

Update a policy and publish it

Updates the policy's description, priority, and configuration and publishes the change. The updateToken from the most recent read is required for optimistic locking.

DATA(lo_result) = lo_client->updatepolicy(
  io_policyconfiguration = new /aws1/cl_nwspolicyconf(
    io_wafconfig = new /aws1/cl_nwswafconfig(
      iv_conflictresolution = |MERGE_WHERE_APPLICABLE|
      iv_exstcustomerwebaclrsln = |NO_REMEDIATION|
    )
    iv_remediationenabled = ABAP_TRUE
    iv_resourcescleanup = ABAP_FALSE
  )
  it_assoctemplateandrulelist = VALUE /aws1/cl_nwstemplateorruleref=>tt_templateandrulereflist(
    ( new /aws1/cl_nwstemplateorruleref( iv_templateidentifier = |arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789| )  )
  )
  iv_ispublished = ABAP_TRUE
  iv_policydescription = |WAF policy for web application protection - updated|
  iv_policyidentifier = |arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789|
  iv_priority = 2
  iv_updatetoken = |e3f4a5b6-6c7d-4e8f-9a0b-0c1d2e3f4a5b|
).