ASSOCIATEUSER()`¶

About AssociateUser¶

Associates the user to an EC2 instance to utilize user-based subscriptions.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

Method Signature¶

METHODS /AWS1/IF_LIS~ASSOCIATEUSER
  IMPORTING
    !IV_USERNAME TYPE /AWS1/LISSTRING OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/LISSTRING OPTIONAL
    !IO_IDENTITYPROVIDER TYPE REF TO /AWS1/CL_LISIDENTITYPROVIDER OPTIONAL
    !IV_DOMAIN TYPE /AWS1/LISSTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LISTAGS_W=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lisassocuserresponse
  RAISING
    /AWS1/CX_LISACCESSDENIEDEX
    /AWS1/CX_LISCONFLICTEXCEPTION
    /AWS1/CX_LISINTERNALSERVEREX
    /AWS1/CX_LISRESOURCENOTFOUNDEX
    /AWS1/CX_LISSERVICEQUOTAEXCDEX
    /AWS1/CX_LISTHROTTLINGEX
    /AWS1/CX_LISVALIDATIONEX
    /AWS1/CX_LISCLIENTEXC
    /AWS1/CX_LISSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_username` `TYPE /AWS1/LISSTRING` `/AWS1/LISSTRING`¶

The user name from the identity provider.

`iv_instanceid` `TYPE /AWS1/LISSTRING` `/AWS1/LISSTRING`¶

The ID of the EC2 instance that provides the user-based subscription.

`io_identityprovider` `TYPE REF TO /AWS1/CL_LISIDENTITYPROVIDER` `/AWS1/CL_LISIDENTITYPROVIDER`¶

The identity provider for the user.

Optional arguments:¶

`iv_domain` `TYPE /AWS1/LISSTRING` `/AWS1/LISSTRING`¶

The domain name of the Active Directory that contains information for the user to associate.

`it_tags` `TYPE /AWS1/CL_LISTAGS_W=>TT_TAGS` `TT_TAGS`¶

The tags that apply for the user association.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lisassocuserresponse` `/AWS1/CL_LISASSOCUSERRESPONSE`¶

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->associateuser(
  io_identityprovider = new /aws1/cl_lisidentityprovider(
    io_activedirectoryidpvdr = new /aws1/cl_lisactdirectoryidpvdr(
      io_activedirectorysettings = new /aws1/cl_lisactdirectorystgs(
        io_domaincredentialsprovider = new /aws1/cl_liscredsprovider( new /aws1/cl_lissecretsmanagercr00( |string| ) )
        io_domainnetworksettings = new /aws1/cl_lisdomainnetworkstgs(
          it_subnets = VALUE /aws1/cl_lissubnets_w=>tt_subnets(
            ( new /aws1/cl_lissubnets_w( |string| ) )
          )
        )
        it_domainipv4list = VALUE /aws1/cl_lisipv4list_w=>tt_ipv4list(
          ( new /aws1/cl_lisipv4list_w( |string| ) )
        )
        it_domainipv6list = VALUE /aws1/cl_lisipv6list_w=>tt_ipv6list(
          ( new /aws1/cl_lisipv6list_w( |string| ) )
        )
        iv_domainname = |string|
      )
      iv_activedirectorytype = |string|
      iv_directoryid = |string|
      iv_issharedactivedirectory = ABAP_TRUE
    )
  )
  it_tags = VALUE /aws1/cl_listags_w=>tt_tags(
    (
      VALUE /aws1/cl_listags_w=>ts_tags_maprow(
        value = new /aws1/cl_listags_w( |string| )
        key = |string|
      )
    )
  )
  iv_domain = |string|
  iv_instanceid = |string|
  iv_username = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_instanceusersummary = lo_result->get_instanceusersummary( ).
  IF lo_instanceusersummary IS NOT INITIAL.
    lv_string = lo_instanceusersummary->get_username( ).
    lv_string = lo_instanceusersummary->get_instanceid( ).
    lo_identityprovider = lo_instanceusersummary->get_identityprovider( ).
    IF lo_identityprovider IS NOT INITIAL.
      lo_activedirectoryidentity = lo_identityprovider->get_activedirectoryidpvdr( ).
      IF lo_activedirectoryidentity IS NOT INITIAL.
        lv_directory = lo_activedirectoryidentity->get_directoryid( ).
        lo_activedirectorysettings = lo_activedirectoryidentity->get_activedirectorysettings( ).
        IF lo_activedirectorysettings IS NOT INITIAL.
          lv_string = lo_activedirectorysettings->get_domainname( ).
          LOOP AT lo_activedirectorysettings->get_domainipv4list( ) into lo_row.
            lo_row_1 = lo_row.
            IF lo_row_1 IS NOT INITIAL.
              lv_ipv4 = lo_row_1->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_activedirectorysettings->get_domainipv6list( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_ipv6 = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
          lo_credentialsprovider = lo_activedirectorysettings->get_domaincredsprovider( ).
          IF lo_credentialsprovider IS NOT INITIAL.
            lo_secretsmanagercredentia = lo_credentialsprovider->get_secretsmanagercredspvdr( ).
            IF lo_secretsmanagercredentia IS NOT INITIAL.
              lv_string = lo_secretsmanagercredentia->get_secretid( ).
            ENDIF.
          ENDIF.
          lo_domainnetworksettings = lo_activedirectorysettings->get_domainnetworksettings( ).
          IF lo_domainnetworksettings IS NOT INITIAL.
            LOOP AT lo_domainnetworksettings->get_subnets( ) into lo_row_4.
              lo_row_5 = lo_row_4.
              IF lo_row_5 IS NOT INITIAL.
                lv_subnet = lo_row_5->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDIF.
        lv_activedirectorytype = lo_activedirectoryidentity->get_activedirectorytype( ).
        lv_boolean = lo_activedirectoryidentity->get_issharedactivedirectory( ).
      ENDIF.
    ENDIF.
    lv_string = lo_instanceusersummary->get_status( ).
    lv_arn = lo_instanceusersummary->get_instanceuserarn( ).
    lv_string = lo_instanceusersummary->get_statusmessage( ).
    lv_string = lo_instanceusersummary->get_domain( ).
    lv_string = lo_instanceusersummary->get_associationdate( ).
    lv_string = lo_instanceusersummary->get_disassociationdate( ).
  ENDIF.
ENDIF.

/AWS1/IF_LIS=>ASSOCIATEUSER()¶