Skip to content

/AWS1/IF_GDY=>CREATEIPSET()

About CreateIPSet

Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with Amazon Web Services infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the administrator account can use this operation.

Method Signature

METHODS /AWS1/IF_GDY~CREATEIPSET
  IMPORTING
    !IV_DETECTORID TYPE /AWS1/GDYDETECTORID OPTIONAL
    !IV_NAME TYPE /AWS1/GDYNAME OPTIONAL
    !IV_FORMAT TYPE /AWS1/GDYIPSETFORMAT OPTIONAL
    !IV_LOCATION TYPE /AWS1/GDYLOCATION OPTIONAL
    !IV_ACTIVATE TYPE /AWS1/GDYBOOLEAN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/GDYCLIENTTOKEN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_GDYTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/GDYACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gdycreateipsetrsp
  RAISING
    /AWS1/CX_GDYACCESSDENIEDEX
    /AWS1/CX_GDYBADREQUESTEX
    /AWS1/CX_GDYINTERNALSERVERER00
    /AWS1/CX_GDYCLIENTEXC
    /AWS1/CX_GDYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_detectorid TYPE /AWS1/GDYDETECTORID /AWS1/GDYDETECTORID

The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

iv_name TYPE /AWS1/GDYNAME /AWS1/GDYNAME

The user-friendly name to identify the IPSet.

Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

iv_format TYPE /AWS1/GDYIPSETFORMAT /AWS1/GDYIPSETFORMAT

The format of the file that contains the IPSet.

iv_location TYPE /AWS1/GDYLOCATION /AWS1/GDYLOCATION

The URI of the file that contains the IPSet.

iv_activate TYPE /AWS1/GDYBOOLEAN /AWS1/GDYBOOLEAN

A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

Optional arguments:

iv_clienttoken TYPE /AWS1/GDYCLIENTTOKEN /AWS1/GDYCLIENTTOKEN

The idempotency token for the create request.

it_tags TYPE /AWS1/CL_GDYTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags to be added to a new IP set resource.

iv_expectedbucketowner TYPE /AWS1/GDYACCOUNTID /AWS1/GDYACCOUNTID

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

RETURNING

oo_output TYPE REF TO /aws1/cl_gdycreateipsetrsp /AWS1/CL_GDYCREATEIPSETRSP

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->createipset(
  it_tags = VALUE /aws1/cl_gdytagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_gdytagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_gdytagmap_w( |string| )
      )
    )
  )
  iv_activate = ABAP_TRUE
  iv_clienttoken = |string|
  iv_detectorid = |string|
  iv_expectedbucketowner = |string|
  iv_format = |string|
  iv_location = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_ipsetid( ).
ENDIF.