Skip to content

/AWS1/IF_OSS=>CREATESECURITYCONFIG()

About CreateSecurityConfig

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Method Signature

METHODS /AWS1/IF_OSS~CREATESECURITYCONFIG
  IMPORTING
    !IV_TYPE TYPE /AWS1/OSSSECURITYCONFIGTYPE OPTIONAL
    !IV_NAME TYPE /AWS1/OSSCONFIGNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/OSSCONFIGDESCRIPTION OPTIONAL
    !IO_SAMLOPTIONS TYPE REF TO /AWS1/CL_OSSSAMLCONFIGOPTIONS OPTIONAL
    !IO_IAMIDENTITYCENTEROPTIONS TYPE REF TO /AWS1/CL_OSSCREIAMIDCENTERCF00 OPTIONAL
    !IO_IAMFEDERATIONOPTIONS TYPE REF TO /AWS1/CL_OSSIAMFEDR8NCFGOPTS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/OSSCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osscreatesecconfigrsp
  RAISING
    /AWS1/CX_OSSCONFLICTEXCEPTION
    /AWS1/CX_OSSINTERNALSERVEREX
    /AWS1/CX_OSSSERVICEQUOTAEXCDEX
    /AWS1/CX_OSSVALIDATIONEX
    /AWS1/CX_OSSCLIENTEXC
    /AWS1/CX_OSSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_type TYPE /AWS1/OSSSECURITYCONFIGTYPE /AWS1/OSSSECURITYCONFIGTYPE

The type of security configuration.

iv_name TYPE /AWS1/OSSCONFIGNAME /AWS1/OSSCONFIGNAME

The name of the security configuration.

Optional arguments:

iv_description TYPE /AWS1/OSSCONFIGDESCRIPTION /AWS1/OSSCONFIGDESCRIPTION

A description of the security configuration.

io_samloptions TYPE REF TO /AWS1/CL_OSSSAMLCONFIGOPTIONS /AWS1/CL_OSSSAMLCONFIGOPTIONS

Describes SAML options in in the form of a key-value map. This field is required if you specify SAML for the type parameter.

io_iamidentitycenteroptions TYPE REF TO /AWS1/CL_OSSCREIAMIDCENTERCF00 /AWS1/CL_OSSCREIAMIDCENTERCF00

Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.

io_iamfederationoptions TYPE REF TO /AWS1/CL_OSSIAMFEDR8NCFGOPTS /AWS1/CL_OSSIAMFEDR8NCFGOPTS

Describes IAM federation options in the form of a key-value map. This field is required if you specify iamFederation for the type parameter.

iv_clienttoken TYPE /AWS1/OSSCLIENTTOKEN /AWS1/OSSCLIENTTOKEN

Unique, case-sensitive identifier to ensure idempotency of the request.

RETURNING

oo_output TYPE REF TO /aws1/cl_osscreatesecconfigrsp /AWS1/CL_OSSCREATESECCONFIGRSP

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->createsecurityconfig(
  io_iamfederationoptions = new /aws1/cl_ossiamfedr8ncfgopts(
    iv_groupattribute = |string|
    iv_userattribute = |string|
  )
  io_iamidentitycenteroptions = new /aws1/cl_osscreiamidcentercf00(
    iv_groupattribute = |string|
    iv_instancearn = |string|
    iv_userattribute = |string|
  )
  io_samloptions = new /aws1/cl_osssamlconfigoptions(
    iv_groupattribute = |string|
    iv_metadata = |string|
    iv_opensrchserverlessentid = |string|
    iv_sessiontimeout = 123
    iv_userattribute = |string|
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_name = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_securityconfigdetail = lo_result->get_securityconfigdetail( ).
  IF lo_securityconfigdetail IS NOT INITIAL.
    lv_securityconfigid = lo_securityconfigdetail->get_id( ).
    lv_securityconfigtype = lo_securityconfigdetail->get_type( ).
    lv_policyversion = lo_securityconfigdetail->get_configversion( ).
    lv_configdescription = lo_securityconfigdetail->get_description( ).
    lo_samlconfigoptions = lo_securityconfigdetail->get_samloptions( ).
    IF lo_samlconfigoptions IS NOT INITIAL.
      lv_samlmetadata = lo_samlconfigoptions->get_metadata( ).
      lv_samluserattribute = lo_samlconfigoptions->get_userattribute( ).
      lv_samlgroupattribute = lo_samlconfigoptions->get_groupattribute( ).
      lv_opensearchserverlessent = lo_samlconfigoptions->get_opensrchserverlessentid( ).
      lv_integer = lo_samlconfigoptions->get_sessiontimeout( ).
    ENDIF.
    lo_iamidentitycenterconfig = lo_securityconfigdetail->get_iamidentitycenteroptions( ).
    IF lo_iamidentitycenterconfig IS NOT INITIAL.
      lv_iamidentitycenterinstan = lo_iamidentitycenterconfig->get_instancearn( ).
      lv_iamidentitycenterapplic = lo_iamidentitycenterconfig->get_applicationarn( ).
      lv_string = lo_iamidentitycenterconfig->get_applicationname( ).
      lv_string = lo_iamidentitycenterconfig->get_applicationdescription( ).
      lv_iamidentitycenteruserat = lo_iamidentitycenterconfig->get_userattribute( ).
      lv_iamidentitycentergroupa = lo_iamidentitycenterconfig->get_groupattribute( ).
    ENDIF.
    lo_iamfederationconfigopti = lo_securityconfigdetail->get_iamfederationoptions( ).
    IF lo_iamfederationconfigopti IS NOT INITIAL.
      lv_iamfederationgroupattri = lo_iamfederationconfigopti->get_groupattribute( ).
      lv_iamfederationuserattrib = lo_iamfederationconfigopti->get_userattribute( ).
    ENDIF.
    lv_long = lo_securityconfigdetail->get_createddate( ).
    lv_long = lo_securityconfigdetail->get_lastmodifieddate( ).
  ENDIF.
ENDIF.