/AWS1/IF_DMG=>CREATEEVENTSUBSCRIPTION()

About CreateEventSubscription

Creates an DMS event notification subscription.

You can specify the type of source (SourceType) you want to be notified of, provide a list of DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all DMS sources belonging to your customer account.

For more information about DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.

Method Signature

METHODS /AWS1/IF_DMG~CREATEEVENTSUBSCRIPTION
  IMPORTING
    !IV_SUBSCRIPTIONNAME TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_SNSTOPICARN TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_SOURCETYPE TYPE /AWS1/DMGSTRING OPTIONAL
    !IT_EVENTCATEGORIES TYPE /AWS1/CL_DMGEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST OPTIONAL
    !IT_SOURCEIDS TYPE /AWS1/CL_DMGSOURCEIDSLIST_W=>TT_SOURCEIDSLIST OPTIONAL
    !IV_ENABLED TYPE /AWS1/DMGBOOLEANOPTIONAL OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_DMGTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgcreevtsubscripti01
  RAISING
    /AWS1/CX_DMGKMSACCDENIEDFAULT
    /AWS1/CX_DMGKMSDISABLEDFAULT
    /AWS1/CX_DMGKMSINVSTATEFAULT
    /AWS1/CX_DMGKMSNOTFOUNDFAULT
    /AWS1/CX_DMGKMSTHROTTLINGFAULT
    /AWS1/CX_DMGRESRCALRDYEXFAULT
    /AWS1/CX_DMGRESRCNOTFOUNDFAULT
    /AWS1/CX_DMGRESRCQUOTAEXCDFA00
    /AWS1/CX_DMGSNSINVTOPICFAULT
    /AWS1/CX_DMGSNSNOAUTHFAULT
    /AWS1/CX_DMGCLIENTEXC
    /AWS1/CX_DMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_subscriptionname TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The name of the DMS event notification subscription. This name must be less than 255 characters.

iv_snstopicarn TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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

Optional arguments:

iv_sourcetype TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The type of DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value isn't specified, all events are returned.

Valid values: replication-instance | replication-task

it_eventcategories TYPE /AWS1/CL_DMGEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST TT_EVENTCATEGORIESLIST

A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.

it_sourceids TYPE /AWS1/CL_DMGSOURCEIDSLIST_W=>TT_SOURCEIDSLIST TT_SOURCEIDSLIST

A list of identifiers for which DMS provides notification events.

If you don't specify a value, notifications are provided for all sources.

If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.

iv_enabled TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.

it_tags TYPE /AWS1/CL_DMGTAG=>TT_TAGLIST TT_TAGLIST

One or more tags to be assigned to the event subscription.

RETURNING

oo_output TYPE REF TO /aws1/cl_dmgcreevtsubscripti01 /AWS1/CL_DMGCREEVTSUBSCRIPTI01

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->createeventsubscription(
  it_eventcategories = VALUE /aws1/cl_dmgeventcatslist_w=>tt_eventcategorieslist(
    ( new /aws1/cl_dmgeventcatslist_w( |string| ) )
  )
  it_sourceids = VALUE /aws1/cl_dmgsourceidslist_w=>tt_sourceidslist(
    ( new /aws1/cl_dmgsourceidslist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_dmgtag=>tt_taglist(
    (
      new /aws1/cl_dmgtag(
        iv_key = |string|
        iv_resourcearn = |string|
        iv_value = |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( ).
  ENDIF.
ENDIF.