MODIFYEVENTSUBSCRIPTION()`¶

About ModifyEventSubscription¶

Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

Method Signature¶

METHODS /AWS1/IF_RDS~MODIFYEVENTSUBSCRIPTION
  IMPORTING
    !IV_SUBSCRIPTIONNAME TYPE /AWS1/RDSSTRING OPTIONAL
    !IV_SNSTOPICARN TYPE /AWS1/RDSSTRING OPTIONAL
    !IV_SOURCETYPE TYPE /AWS1/RDSSTRING OPTIONAL
    !IT_EVENTCATEGORIES TYPE /AWS1/CL_RDSEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST OPTIONAL
    !IV_ENABLED TYPE /AWS1/RDSBOOLEANOPTIONAL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rdsmdevtsubscriptio01
  RAISING
    /AWS1/CX_RDSEVTSUBSCRIPTIONQ00
    /AWS1/CX_RDSSNSINVTOPICFAULT
    /AWS1/CX_RDSSNSNOAUTHFAULT
    /AWS1/CX_RDSSNSTPCARNNOTFNDF00
    /AWS1/CX_RDSSUBSCRIPTIONCATN00
    /AWS1/CX_RDSSUBSCRIPTIONNOTF00
    /AWS1/CX_RDSCLIENTEXC
    /AWS1/CX_RDSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_subscriptionname` `TYPE /AWS1/RDSSTRING` `/AWS1/RDSSTRING`¶

The name of the RDS event notification subscription.

Optional arguments:¶

`iv_snstopicarn` `TYPE /AWS1/RDSSTRING` `/AWS1/RDSSTRING`¶

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

`iv_sourcetype` `TYPE /AWS1/RDSSTRING` `/AWS1/RDSSTRING`¶

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment

`it_eventcategories` `TYPE /AWS1/CL_RDSEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST` `TT_EVENTCATEGORIESLIST`¶

A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.

`iv_enabled` `TYPE /AWS1/RDSBOOLEANOPTIONAL` `/AWS1/RDSBOOLEANOPTIONAL`¶

Specifies whether to activate the subscription.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rdsmdevtsubscriptio01` `/AWS1/CL_RDSMDEVTSUBSCRIPTIO01`¶

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->modifyeventsubscription(
  it_eventcategories = VALUE /aws1/cl_rdseventcatslist_w=>tt_eventcategorieslist(
    ( new /aws1/cl_rdseventcatslist_w( |string| ) )
  )
  iv_enabled = ABAP_TRUE
  iv_snstopicarn = |string|
  iv_sourcetype = |string|
  iv_subscriptionname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_eventsubscription = lo_result->get_eventsubscription( ).
  IF lo_eventsubscription IS NOT INITIAL.
    lv_string = lo_eventsubscription->get_customerawsid( ).
    lv_string = lo_eventsubscription->get_custsubscriptionid( ).
    lv_string = lo_eventsubscription->get_snstopicarn( ).
    lv_string = lo_eventsubscription->get_status( ).
    lv_string = lo_eventsubscription->get_subscriptioncreationtime( ).
    lv_string = lo_eventsubscription->get_sourcetype( ).
    LOOP AT lo_eventsubscription->get_sourceidslist( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_eventsubscription->get_eventcategorieslist( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_string = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_boolean = lo_eventsubscription->get_enabled( ).
    lv_string = lo_eventsubscription->get_eventsubscriptionarn( ).
  ENDIF.
ENDIF.

To modify an event subscription¶

The following example turns off the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic.

DATA(lo_result) = lo_client->modifyeventsubscription(
  iv_enabled = ABAP_FALSE
  iv_subscriptionname = |my-instance-events|
).

/AWS1/IF_RDS=>MODIFYEVENTSUBSCRIPTION()¶