CREATERULESNAPSHOT()`¶

About CreateRuleSnapshot¶

Creates a snapshot of the current published version of the specified rule. A snapshot is an immutable, versioned copy that other resources can reference.

Method Signature¶

METHODS /AWS1/IF_NWS~CREATERULESNAPSHOT
  IMPORTING
    !IV_RULEIDENTIFIER TYPE /AWS1/NWSRULEIDENTIFIER OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/NWSIDEMPOTENCYTOKEN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_NWSTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nwscreaterulesnapout
  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_ruleidentifier` `TYPE /AWS1/NWSRULEIDENTIFIER` `/AWS1/NWSRULEIDENTIFIER`¶

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

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.

`it_tags` `TYPE /AWS1/CL_NWSTAGMAP_W=>TT_TAGMAP` `TT_TAGMAP`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_nwscreaterulesnapout` `/AWS1/CL_NWSCREATERULESNAPOUT`¶

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->createrulesnapshot(
  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_ruleidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_ruleid = lo_result->get_ruleid( ).
  lv_rulearn = lo_result->get_rulearn( ).
  lv_rulename = lo_result->get_rulename( ).
  lv_rulefirewalltype = lo_result->get_firewalltype( ).
  lv_ruletype = lo_result->get_ruletype( ).
  lv_description = lo_result->get_ruledescription( ).
  lo_/aws1/cl_rt_document = lo_result->get_configuration( ).
  IF lo_/aws1/cl_rt_document IS NOT INITIAL.
  ENDIF.
  lv_entitystatus = lo_result->get_status( ).
  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_datetimestamp = lo_result->get_updatedat( ).
ENDIF.

Create a rule snapshot¶

Creates an immutable snapshot of the current published version of a rule. The snapshot is addressable by a version-qualified ARN.

DATA(lo_result) = lo_client->createrulesnapshot(
  iv_clienttoken = |550e8400-e29b-41d4-a716-446655440011|
  iv_ruleidentifier = |arn:aws:network-security-manager:us-east-1:123456789012:rule:abc123|
).

/AWS1/IF_NWS=>CREATERULESNAPSHOT()¶