Skip to content

/AWS1/CL_EVB=>UPDATEEVENTBUS()

About UpdateEventBus

Updates the specified event bus.

Method Signature

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/EVBEVENTBUSNAME /AWS1/EVBEVENTBUSNAME

The name of the event bus.

iv_kmskeyidentifier TYPE /AWS1/EVBKMSKEYIDENTIFIER /AWS1/EVBKMSKEYIDENTIFIER

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt events on the event bus.

For more information, see Identify and view keys in the Key Management Service Developer Guide.

Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

  • You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

  • You call UpdatedEventBus to set a customer managed key on an event bus with schema discovery enabled.

To enable schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Encrypting events in the Amazon EventBridge User Guide.

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

iv_description TYPE /AWS1/EVBEVENTBUSDESCRIPTION /AWS1/EVBEVENTBUSDESCRIPTION

The event bus description.

io_deadletterconfig TYPE REF TO /AWS1/CL_EVBDEADLETTERCONFIG /AWS1/CL_EVBDEADLETTERCONFIG

DeadLetterConfig

io_logconfig TYPE REF TO /AWS1/CL_EVBLOGCONFIG /AWS1/CL_EVBLOGCONFIG

The logging configuration settings for the event bus.

For more information, see Configuring logs for event buses in the EventBridge User Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_evbupdateebusresponse /AWS1/CL_EVBUPDATEEBUSRESPONSE

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->/aws1/if_evb~updateeventbus(
  io_deadletterconfig = new /aws1/cl_evbdeadletterconfig( |string| )
  io_logconfig = new /aws1/cl_evblogconfig(
    iv_includedetail = |string|
    iv_level = |string|
  )
  iv_description = |string|
  iv_kmskeyidentifier = |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_arn( ).
  lv_eventbusname = lo_result->get_name( ).
  lv_kmskeyidentifier = lo_result->get_kmskeyidentifier( ).
  lv_eventbusdescription = lo_result->get_description( ).
  lo_deadletterconfig = lo_result->get_deadletterconfig( ).
  IF lo_deadletterconfig IS NOT INITIAL.
    lv_resourcearn = lo_deadletterconfig->get_arn( ).
  ENDIF.
  lo_logconfig = lo_result->get_logconfig( ).
  IF lo_logconfig IS NOT INITIAL.
    lv_includedetail = lo_logconfig->get_includedetail( ).
    lv_level = lo_logconfig->get_level( ).
  ENDIF.
ENDIF.