Skip to content

/AWS1/IF_SHD=>CREATEPROTECTIONGROUP()

About CreateProtectionGroup

Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

Method Signature

METHODS /AWS1/IF_SHD~CREATEPROTECTIONGROUP
  IMPORTING
    !IV_PROTECTIONGROUPID TYPE /AWS1/SHDPROTECTIONGROUPID OPTIONAL
    !IV_AGGREGATION TYPE /AWS1/SHDPROTECTIONGROUPAGGR OPTIONAL
    !IV_PATTERN TYPE /AWS1/SHDPROTECTIONGROUPPAT OPTIONAL
    !IV_RESOURCETYPE TYPE /AWS1/SHDPROTECTEDRESOURCETYPE OPTIONAL
    !IT_MEMBERS TYPE /AWS1/CL_SHDPROTECTIONGRMEMB00=>TT_PROTECTIONGROUPMEMBERS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SHDTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_shdcreprotectiongrrsp
  RAISING
    /AWS1/CX_SHDINTERNALERROREX
    /AWS1/CX_SHDINVALIDPARAMETEREX
    /AWS1/CX_SHDLIMITSEXCEEDEDEX
    /AWS1/CX_SHDOPTIMISTICLOCKEX
    /AWS1/CX_SHDRESRCALRDYEXISTSEX
    /AWS1/CX_SHDRESOURCENOTFOUNDEX
    /AWS1/CX_SHDCLIENTEXC
    /AWS1/CX_SHDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_protectiongroupid TYPE /AWS1/SHDPROTECTIONGROUPID /AWS1/SHDPROTECTIONGROUPID

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

iv_aggregation TYPE /AWS1/SHDPROTECTIONGROUPAGGR /AWS1/SHDPROTECTIONGROUPAGGR

Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

  • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

  • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

  • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.

iv_pattern TYPE /AWS1/SHDPROTECTIONGROUPPAT /AWS1/SHDPROTECTIONGROUPPAT

The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Optional arguments:

iv_resourcetype TYPE /AWS1/SHDPROTECTEDRESOURCETYPE /AWS1/SHDPROTECTEDRESOURCETYPE

The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

it_members TYPE /AWS1/CL_SHDPROTECTIONGRMEMB00=>TT_PROTECTIONGROUPMEMBERS TT_PROTECTIONGROUPMEMBERS

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

it_tags TYPE /AWS1/CL_SHDTAG=>TT_TAGLIST TT_TAGLIST

One or more tag key-value pairs for the protection group.

RETURNING

oo_output TYPE REF TO /aws1/cl_shdcreprotectiongrrsp /AWS1/CL_SHDCREPROTECTIONGRRSP

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->createprotectiongroup(
  it_members = VALUE /aws1/cl_shdprotectiongrmemb00=>tt_protectiongroupmembers(
    ( new /aws1/cl_shdprotectiongrmemb00( |string| ) )
  )
  it_tags = VALUE /aws1/cl_shdtag=>tt_taglist(
    (
      new /aws1/cl_shdtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_aggregation = |string|
  iv_pattern = |string|
  iv_protectiongroupid = |string|
  iv_resourcetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.