UPDATEBROKER()`¶

About UpdateBroker¶

Adds a pending configuration change to a broker.

Method Signature¶

METHODS /AWS1/IF_MQ~UPDATEBROKER
  IMPORTING
    !IV_AUTHENTICATIONSTRATEGY TYPE /AWS1/MQ_AUTHNTCTNSTRATEGY OPTIONAL
    !IV_AUTOMINORVERSIONUPGRADE TYPE /AWS1/MQ___BOOLEAN OPTIONAL
    !IV_BROKERID TYPE /AWS1/MQ___STRING OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_MQ_CONFIGURATIONID OPTIONAL
    !IV_ENGINEVERSION TYPE /AWS1/MQ___STRING OPTIONAL
    !IV_HOSTINSTANCETYPE TYPE /AWS1/MQ___STRING OPTIONAL
    !IO_LDAPSERVERMETADATA TYPE REF TO /AWS1/CL_MQ_LDAPSERVERMETINPUT OPTIONAL
    !IO_LOGS TYPE REF TO /AWS1/CL_MQ_LOGS OPTIONAL
    !IO_MAINTENANCEWINDOWSTRTTIME TYPE REF TO /AWS1/CL_MQ_WEEKLYSTARTTIME OPTIONAL
    !IT_SECURITYGROUPS TYPE /AWS1/CL_MQ___LISTOF__STRING_W=>TT___LISTOF__STRING OPTIONAL
    !IV_DATAREPLICATIONMODE TYPE /AWS1/MQ_DATAREPLICATIONMODE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mq_updatebrokerrsp
  RAISING
    /AWS1/CX_MQ_BADREQUESTEX
    /AWS1/CX_MQ_CONFLICTEXCEPTION
    /AWS1/CX_MQ_FORBIDDENEXCEPTION
    /AWS1/CX_MQ_INTERNALSERVERER00
    /AWS1/CX_MQ_NOTFOUNDEXCEPTION
    /AWS1/CX_MQ_CLIENTEXC
    /AWS1/CX_MQ_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_brokerid` `TYPE /AWS1/MQ_STRING` `/AWS1/MQ_STRING`¶

The unique ID that Amazon MQ generates for the broker.

Optional arguments:¶

`iv_authenticationstrategy` `TYPE /AWS1/MQ_AUTHNTCTNSTRATEGY` `/AWS1/MQ_AUTHNTCTNSTRATEGY`¶

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

`iv_autominorversionupgrade` `TYPE /AWS1/MQ_BOOLEAN` `/AWS1/MQ_BOOLEAN`¶

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

`io_configuration` `TYPE REF TO /AWS1/CL_MQ_CONFIGURATIONID` `/AWS1/CL_MQ_CONFIGURATIONID`¶

A list of information about the configuration.

`iv_engineversion` `TYPE /AWS1/MQ_STRING` `/AWS1/MQ_STRING`¶

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

`iv_hostinstancetype` `TYPE /AWS1/MQ_STRING` `/AWS1/MQ_STRING`¶

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

`io_ldapservermetadata` `TYPE REF TO /AWS1/CL_MQ_LDAPSERVERMETINPUT` `/AWS1/CL_MQ_LDAPSERVERMETINPUT`¶

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

`io_logs` `TYPE REF TO /AWS1/CL_MQ_LOGS` `/AWS1/CL_MQ_LOGS`¶

Enables Amazon CloudWatch logging for brokers.

`io_maintenancewindowstrttime` `TYPE REF TO /AWS1/CL_MQ_WEEKLYSTARTTIME` `/AWS1/CL_MQ_WEEKLYSTARTTIME`¶

The parameters that determine the WeeklyStartTime.

`it_securitygroups` `TYPE /AWS1/CL_MQ_LISTOFSTRING_W=>TT_LISTOFSTRING` `TT_LISTOFSTRING`¶

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

`iv_datareplicationmode` `TYPE /AWS1/MQ_DATAREPLICATIONMODE` `/AWS1/MQ_DATAREPLICATIONMODE`¶

Defines whether this broker is a part of a data replication pair.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_mq_updatebrokerrsp` `/AWS1/CL_MQ_UPDATEBROKERRSP`¶

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->updatebroker(
  io_configuration = new /aws1/cl_mq_configurationid(
    iv_id = |string|
    iv_revision = 123
  )
  io_ldapservermetadata = new /aws1/cl_mq_ldapservermetinput(
    it_hosts = VALUE /aws1/cl_mq___listof__string_w=>tt___listof__string(
      ( new /aws1/cl_mq___listof__string_w( |string| ) )
    )
    iv_rolebase = |string|
    iv_rolename = |string|
    iv_rolesearchmatching = |string|
    iv_rolesearchsubtree = ABAP_TRUE
    iv_serviceaccountpassword = |string|
    iv_serviceaccountusername = |string|
    iv_userbase = |string|
    iv_userrolename = |string|
    iv_usersearchmatching = |string|
    iv_usersearchsubtree = ABAP_TRUE
  )
  io_logs = new /aws1/cl_mq_logs(
    iv_audit = ABAP_TRUE
    iv_general = ABAP_TRUE
  )
  io_maintenancewindowstrttime = new /aws1/cl_mq_weeklystarttime(
    iv_dayofweek = |string|
    iv_timeofday = |string|
    iv_timezone = |string|
  )
  it_securitygroups = VALUE /aws1/cl_mq___listof__string_w=>tt___listof__string(
    ( new /aws1/cl_mq___listof__string_w( |string| ) )
  )
  iv_authenticationstrategy = |string|
  iv_autominorversionupgrade = ABAP_TRUE
  iv_brokerid = |string|
  iv_datareplicationmode = |string|
  iv_engineversion = |string|
  iv_hostinstancetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_authenticationstrategy = lo_result->get_authenticationstrategy( ).
  lv___boolean = lo_result->get_autominorversionupgrade( ).
  lv___string = lo_result->get_brokerid( ).
  lo_configurationid = lo_result->get_configuration( ).
  IF lo_configurationid IS NOT INITIAL.
    lv___string = lo_configurationid->get_id( ).
    lv___integer = lo_configurationid->get_revision( ).
  ENDIF.
  lv___string = lo_result->get_engineversion( ).
  lv___string = lo_result->get_hostinstancetype( ).
  lo_ldapservermetadataoutpu = lo_result->get_ldapservermetadata( ).
  IF lo_ldapservermetadataoutpu IS NOT INITIAL.
    LOOP AT lo_ldapservermetadataoutpu->get_hosts( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv___string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv___string = lo_ldapservermetadataoutpu->get_rolebase( ).
    lv___string = lo_ldapservermetadataoutpu->get_rolename( ).
    lv___string = lo_ldapservermetadataoutpu->get_rolesearchmatching( ).
    lv___boolean = lo_ldapservermetadataoutpu->get_rolesearchsubtree( ).
    lv___string = lo_ldapservermetadataoutpu->get_serviceaccountusername( ).
    lv___string = lo_ldapservermetadataoutpu->get_userbase( ).
    lv___string = lo_ldapservermetadataoutpu->get_userrolename( ).
    lv___string = lo_ldapservermetadataoutpu->get_usersearchmatching( ).
    lv___boolean = lo_ldapservermetadataoutpu->get_usersearchsubtree( ).
  ENDIF.
  lo_logs = lo_result->get_logs( ).
  IF lo_logs IS NOT INITIAL.
    lv___boolean = lo_logs->get_audit( ).
    lv___boolean = lo_logs->get_general( ).
  ENDIF.
  lo_weeklystarttime = lo_result->get_maintenancewindowstrtt00( ).
  IF lo_weeklystarttime IS NOT INITIAL.
    lv_dayofweek = lo_weeklystarttime->get_dayofweek( ).
    lv___string = lo_weeklystarttime->get_timeofday( ).
    lv___string = lo_weeklystarttime->get_timezone( ).
  ENDIF.
  LOOP AT lo_result->get_securitygroups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv___string = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lo_datareplicationmetadata = lo_result->get_datareplicationmetadata( ).
  IF lo_datareplicationmetadata IS NOT INITIAL.
    lo_datareplicationcounterp = lo_datareplicationmetadata->get_datareplcounterpart( ).
    IF lo_datareplicationcounterp IS NOT INITIAL.
      lv___string = lo_datareplicationcounterp->get_brokerid( ).
      lv___string = lo_datareplicationcounterp->get_region( ).
    ENDIF.
    lv___string = lo_datareplicationmetadata->get_datareplicationrole( ).
  ENDIF.
  lv_datareplicationmode = lo_result->get_datareplicationmode( ).
  lo_datareplicationmetadata = lo_result->get_pendingdatareplmetadata( ).
  IF lo_datareplicationmetadata IS NOT INITIAL.
    lo_datareplicationcounterp = lo_datareplicationmetadata->get_datareplcounterpart( ).
    IF lo_datareplicationcounterp IS NOT INITIAL.
      lv___string = lo_datareplicationcounterp->get_brokerid( ).
      lv___string = lo_datareplicationcounterp->get_region( ).
    ENDIF.
    lv___string = lo_datareplicationmetadata->get_datareplicationrole( ).
  ENDIF.
  lv_datareplicationmode = lo_result->get_pendingdatareplmode( ).
ENDIF.

/AWS1/IF_MQ=>UPDATEBROKER()¶

About UpdateBroker¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_brokerid TYPE /AWS1/MQ___STRING /AWS1/MQ___STRING¶

Optional arguments:¶

iv_authenticationstrategy TYPE /AWS1/MQ_AUTHNTCTNSTRATEGY /AWS1/MQ_AUTHNTCTNSTRATEGY¶

iv_autominorversionupgrade TYPE /AWS1/MQ___BOOLEAN /AWS1/MQ___BOOLEAN¶

io_configuration TYPE REF TO /AWS1/CL_MQ_CONFIGURATIONID /AWS1/CL_MQ_CONFIGURATIONID¶

iv_engineversion TYPE /AWS1/MQ___STRING /AWS1/MQ___STRING¶

iv_hostinstancetype TYPE /AWS1/MQ___STRING /AWS1/MQ___STRING¶

io_ldapservermetadata TYPE REF TO /AWS1/CL_MQ_LDAPSERVERMETINPUT /AWS1/CL_MQ_LDAPSERVERMETINPUT¶

io_logs TYPE REF TO /AWS1/CL_MQ_LOGS /AWS1/CL_MQ_LOGS¶

io_maintenancewindowstrttime TYPE REF TO /AWS1/CL_MQ_WEEKLYSTARTTIME /AWS1/CL_MQ_WEEKLYSTARTTIME¶

it_securitygroups TYPE /AWS1/CL_MQ___LISTOF__STRING_W=>TT___LISTOF__STRING TT___LISTOF__STRING¶

iv_datareplicationmode TYPE /AWS1/MQ_DATAREPLICATIONMODE /AWS1/MQ_DATAREPLICATIONMODE¶