Skip to content

/AWS1/IF_NWS=>CREATETEMPLATE()

About CreateTemplate

Creates a template. A template groups one or more rules to simplify reuse across policies. You can also associate rules with a policy directly, without a template. Use isPublished to create the template in published (ACTIVE) or draft (DRAFT) state.

Method Signature

METHODS /AWS1/IF_NWS~CREATETEMPLATE
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/NWSIDEMPOTENCYTOKEN OPTIONAL
    !IV_TEMPLATENAME TYPE /AWS1/NWSTEMPLATENAME OPTIONAL
    !IV_TEMPLATEDESCRIPTION TYPE /AWS1/NWSDESCRIPTION OPTIONAL
    !IT_ASSOCIATEDRULELIST TYPE /AWS1/CL_NWSRULEREFERENCE=>TT_RULEREFERENCELIST OPTIONAL
    !IV_FIREWALLTYPE TYPE /AWS1/NWSTEMPLATEFIREWALLTYPE OPTIONAL
    !IV_ISPUBLISHED TYPE /AWS1/NWSISPUBLISHED OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_NWSTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nwscreatetmploutput
  RAISING
    /AWS1/CX_NWSACCESSDENIEDEX
    /AWS1/CX_NWSCONFLICTEXCEPTION
    /AWS1/CX_NWSINTERNALSERVEREX
    /AWS1/CX_NWSSERVICEQUOTAEXCDEX
    /AWS1/CX_NWSSERVICEUNAVAILEX
    /AWS1/CX_NWSTAGPOLICYVIOEX
    /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_templatename TYPE /AWS1/NWSTEMPLATENAME /AWS1/NWSTEMPLATENAME

The name of the template.

it_associatedrulelist TYPE /AWS1/CL_NWSRULEREFERENCE=>TT_RULEREFERENCELIST TT_RULEREFERENCELIST

The rules associated with the template.

iv_firewalltype TYPE /AWS1/NWSTEMPLATEFIREWALLTYPE /AWS1/NWSTEMPLATEFIREWALLTYPE

The firewall type associated with the resource.

Optional arguments:

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.

iv_templatedescription TYPE /AWS1/NWSDESCRIPTION /AWS1/NWSDESCRIPTION

A description of the template.

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). Default: true.

it_tags TYPE /AWS1/CL_NWSTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags to add to the resource when it is created.

RETURNING

oo_output TYPE REF TO /aws1/cl_nwscreatetmploutput /AWS1/CL_NWSCREATETMPLOUTPUT

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->createtemplate(
  it_associatedrulelist = VALUE /aws1/cl_nwsrulereference=>tt_rulereferencelist(
    ( new /aws1/cl_nwsrulereference( |string| ) )
  )
  it_tags = VALUE /aws1/cl_nwstagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_nwstagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_nwstagmap_w( |string| )
      )
    )
  )
  iv_clienttoken = |string|
  iv_firewalltype = |string|
  iv_ispublished = ABAP_TRUE
  iv_templatedescription = |string|
  iv_templatename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_templateid = lo_result->get_templateid( ).
  lv_templatearn = lo_result->get_templatearn( ).
  lv_templatename = lo_result->get_templatename( ).
  lv_description = lo_result->get_templatedescription( ).
  lv_entitystatus = lo_result->get_status( ).
  lv_entityversion = lo_result->get_version( ).
  LOOP AT lo_result->get_associatedrulelist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_rulearn = lo_row_1->get_rulearn( ).
    ENDIF.
  ENDLOOP.
  lv_updatetoken = lo_result->get_updatetoken( ).
  lv_issnapshot = lo_result->get_issnapshot( ).
  lv_haspublishedversion = lo_result->get_haspublishedversion( ).
  lv_templatefirewalltype = lo_result->get_firewalltype( ).
  lv_datetimestamp = lo_result->get_updatedat( ).
ENDIF.

Create a WAF template

Creates a new WAF template in published (ACTIVE) state with an associated rule.

DATA(lo_result) = lo_client->createtemplate(
  it_associatedrulelist = VALUE /aws1/cl_nwsrulereference=>tt_rulereferencelist(
    ( new /aws1/cl_nwsrulereference( |arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123| ) )
  )
  iv_clienttoken = |550e8400-e29b-41d4-a716-446655440004|
  iv_firewalltype = |WAF|
  iv_ispublished = ABAP_TRUE
  iv_templatedescription = |Standard WAF template with baseline rule groups|
  iv_templatename = |standard-waf-template|
).