Skip to content

/AWS1/IF_DOD=>CREATEEVENTSUBSCRIPTION()

About CreateEventSubscription

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

Method Signature

IMPORTING

Required arguments:

iv_subscriptionname TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

iv_snstopicarn TYPE /AWS1/DODSTRING /AWS1/DODSTRING

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

Optional arguments:

iv_sourcetype TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

Valid values: db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot

it_eventcategories TYPE /AWS1/CL_DODEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST TT_EVENTCATEGORIESLIST

A list of event categories for a SourceType that you want to subscribe to.

it_sourceids TYPE /AWS1/CL_DODSOURCEIDSLIST_W=>TT_SOURCEIDSLIST TT_SOURCEIDSLIST

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are provided, SourceType must also be provided.

  • If the source type is an instance, a DBInstanceIdentifier must be provided.

  • If the source type is a security group, a DBSecurityGroupName must be provided.

  • If the source type is a parameter group, a DBParameterGroupName must be provided.

  • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

iv_enabled TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL

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

it_tags TYPE /AWS1/CL_DODTAG=>TT_TAGLIST TT_TAGLIST

The tags to be assigned to the event subscription.

RETURNING

oo_output TYPE REF TO /aws1/cl_dodcreevtsubscripti01 /AWS1/CL_DODCREEVTSUBSCRIPTI01

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_dod~createeventsubscription(
  it_eventcategories = VALUE /aws1/cl_dodeventcatslist_w=>tt_eventcategorieslist(
    ( new /aws1/cl_dodeventcatslist_w( |string| ) )
  )
  it_sourceids = VALUE /aws1/cl_dodsourceidslist_w=>tt_sourceidslist(
    ( new /aws1/cl_dodsourceidslist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_dodtag=>tt_taglist(
    (
      new /aws1/cl_dodtag(
        iv_key = |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( ).
    lv_string = lo_eventsubscription->get_eventsubscriptionarn( ).
  ENDIF.
ENDIF.