Skip to content

/AWS1/IF_MDL=>CREATECLOUDWATCHALARMTMPL()

About CreateCloudWatchAlarmTemplate

Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.

Method Signature

METHODS /AWS1/IF_MDL~CREATECLOUDWATCHALARMTMPL
  IMPORTING
    !IV_COMPARISONOPERATOR TYPE /AWS1/MDLCLOUDWATCHALRMTMPLC00 OPTIONAL
    !IV_DATAPOINTSTOALARM TYPE /AWS1/MDL__INTEGERMIN1 OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/MDL__STRINGMIN0MAX1024 OPTIONAL
    !IV_EVALUATIONPERIODS TYPE /AWS1/MDL__INTEGERMIN1 OPTIONAL
    !IV_GROUPIDENTIFIER TYPE /AWS1/MDL__STRINGPATTERNS OPTIONAL
    !IV_METRICNAME TYPE /AWS1/MDL__STRINGMAX64 OPTIONAL
    !IV_NAME TYPE /AWS1/MDL__STRMIN1MAX255PATS OPTIONAL
    !IV_PERIOD TYPE /AWS1/MDL__INTEGERMIN10MAX8600 OPTIONAL
    !IV_STATISTIC TYPE /AWS1/MDLCLOUDWATCHALRMTMPLS00 OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_MDLTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_TARGETRESOURCETYPE TYPE /AWS1/MDLCLOUDWATCHALRMTMPLT00 OPTIONAL
    !IV_THRESHOLD TYPE /AWS1/RT_DOUBLE_AS_STRING OPTIONAL
    !IV_TREATMISSINGDATA TYPE /AWS1/MDLCLOUDWATCHALRMTMPLT01 OPTIONAL
    !IV_REQUESTID TYPE /AWS1/MDL__STRMIN1MAX256PATS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mdlcrecloudwatchalr01
  RAISING
    /AWS1/CX_MDLBADREQUESTEX
    /AWS1/CX_MDLCONFLICTEXCEPTION
    /AWS1/CX_MDLFORBIDDENEXCEPTION
    /AWS1/CX_MDLINTERNALSERVERER00
    /AWS1/CX_MDLNOTFOUNDEXCEPTION
    /AWS1/CX_MDLTOOMANYREQUESTSEX
    /AWS1/CX_MDLCLIENTEXC
    /AWS1/CX_MDLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_comparisonoperator TYPE /AWS1/MDLCLOUDWATCHALRMTMPLC00 /AWS1/MDLCLOUDWATCHALRMTMPLC00

ComparisonOperator

iv_evaluationperiods TYPE /AWS1/MDL__INTEGERMIN1 /AWS1/MDL__INTEGERMIN1

The number of periods over which data is compared to the specified threshold.

iv_groupidentifier TYPE /AWS1/MDL__STRINGPATTERNS /AWS1/MDL__STRINGPATTERNS

A cloudwatch alarm template group's identifier. Can be either be its id or current name.

iv_metricname TYPE /AWS1/MDL__STRINGMAX64 /AWS1/MDL__STRINGMAX64

The name of the metric associated with the alarm. Must be compatible with targetResourceType.

iv_name TYPE /AWS1/MDL__STRMIN1MAX255PATS /AWS1/MDL__STRMIN1MAX255PATS

A resource's name. Names must be unique within the scope of a resource type in a specific region.

iv_period TYPE /AWS1/MDL__INTEGERMIN10MAX8600 /AWS1/MDL__INTEGERMIN10MAX8600

The period, in seconds, over which the specified statistic is applied.

iv_statistic TYPE /AWS1/MDLCLOUDWATCHALRMTMPLS00 /AWS1/MDLCLOUDWATCHALRMTMPLS00

Statistic

iv_targetresourcetype TYPE /AWS1/MDLCLOUDWATCHALRMTMPLT00 /AWS1/MDLCLOUDWATCHALRMTMPLT00

TargetResourceType

iv_threshold TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The threshold value to compare with the specified statistic.

iv_treatmissingdata TYPE /AWS1/MDLCLOUDWATCHALRMTMPLT01 /AWS1/MDLCLOUDWATCHALRMTMPLT01

TreatMissingData

Optional arguments:

iv_datapointstoalarm TYPE /AWS1/MDL__INTEGERMIN1 /AWS1/MDL__INTEGERMIN1

The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

iv_description TYPE /AWS1/MDL__STRINGMIN0MAX1024 /AWS1/MDL__STRINGMIN0MAX1024

A resource's optional description.

it_tags TYPE /AWS1/CL_MDLTAGMAP_W=>TT_TAGMAP TT_TAGMAP

Tags

iv_requestid TYPE /AWS1/MDL__STRMIN1MAX256PATS /AWS1/MDL__STRMIN1MAX256PATS

An ID that you assign to a create request. This ID ensures idempotency when creating resources.

RETURNING

oo_output TYPE REF TO /aws1/cl_mdlcrecloudwatchalr01 /AWS1/CL_MDLCRECLOUDWATCHALR01

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->createcloudwatchalarmtmpl(
  it_tags = VALUE /aws1/cl_mdltagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_mdltagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_mdltagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_comparisonoperator = |string|
  iv_datapointstoalarm = 123
  iv_description = |string|
  iv_evaluationperiods = 123
  iv_groupidentifier = |string|
  iv_metricname = |string|
  iv_name = |string|
  iv_period = 123
  iv_requestid = |string|
  iv_statistic = |string|
  iv_targetresourcetype = |string|
  iv_threshold = |0.1|
  iv_treatmissingdata = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv___stringpatternarnmedia = lo_result->get_arn( ).
  lv_cloudwatchalarmtemplate = lo_result->get_comparisonoperator( ).
  lv___timestampiso8601 = lo_result->get_createdat( ).
  lv___integermin1 = lo_result->get_datapointstoalarm( ).
  lv___stringmin0max1024 = lo_result->get_description( ).
  lv___integermin1 = lo_result->get_evaluationperiods( ).
  lv___stringmin7max11patter = lo_result->get_groupid( ).
  lv___stringmin7max11patter = lo_result->get_id( ).
  lv___stringmax64 = lo_result->get_metricname( ).
  lv___timestampiso8601 = lo_result->get_modifiedat( ).
  lv___stringmin1max255patte = lo_result->get_name( ).
  lv___integermin10max86400 = lo_result->get_period( ).
  lv_cloudwatchalarmtemplate_1 = lo_result->get_statistic( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv___string = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_cloudwatchalarmtemplate_2 = lo_result->get_targetresourcetype( ).
  lv___double = lo_result->get_threshold( ).
  lv_cloudwatchalarmtemplate_3 = lo_result->get_treatmissingdata( ).
ENDIF.