Skip to content

/AWS1/IF_CWM=>UPDATEMONITOR()

About UpdateMonitor

Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.

The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

Method Signature

METHODS /AWS1/IF_CWM~UPDATEMONITOR
  IMPORTING
    !IV_MONITORNAME TYPE /AWS1/CWMRESOURCENAME OPTIONAL
    !IT_RESOURCESTOADD TYPE /AWS1/CL_CWMSETOFARNS_W=>TT_SETOFARNS OPTIONAL
    !IT_RESOURCESTOREMOVE TYPE /AWS1/CL_CWMSETOFARNS_W=>TT_SETOFARNS OPTIONAL
    !IV_STATUS TYPE /AWS1/CWMMONITORCONFIGSTATE OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/CWMSTRING OPTIONAL
    !IV_MAXCITYNETWORKSTOMONITOR TYPE /AWS1/CWMMAXCITYNETWORKSTOMONI OPTIONAL
    !IO_INTERNETMEASUREMENTSLOG00 TYPE REF TO /AWS1/CL_CWMINTERNETMEASUREM00 OPTIONAL
    !IV_TRAFFICPERCENTAGETOMONI TYPE /AWS1/CWMTRAFPERCENTAGETOMONI OPTIONAL
    !IO_HEALTHEVENTSCONFIG TYPE REF TO /AWS1/CL_CWMHEALTHEVENTSCONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwmupdatemonioutput
  RAISING
    /AWS1/CX_CWMACCESSDENIEDEX
    /AWS1/CX_CWMINTERNALSERVEREX
    /AWS1/CX_CWMLIMITEXCEEDEDEX
    /AWS1/CX_CWMRESOURCENOTFOUNDEX
    /AWS1/CX_CWMTHROTTLINGEX
    /AWS1/CX_CWMVALIDATIONEX
    /AWS1/CX_CWMCLIENTEXC
    /AWS1/CX_CWMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_monitorname TYPE /AWS1/CWMRESOURCENAME /AWS1/CWMRESOURCENAME

The name of the monitor.

Optional arguments:

it_resourcestoadd TYPE /AWS1/CL_CWMSETOFARNS_W=>TT_SETOFARNS TT_SETOFARNS

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.

You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.

If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

it_resourcestoremove TYPE /AWS1/CL_CWMSETOFARNS_W=>TT_SETOFARNS TT_SETOFARNS

The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

iv_status TYPE /AWS1/CWMMONITORCONFIGSTATE /AWS1/CWMMONITORCONFIGSTATE

The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and INACTIVE. The following values are not accepted: PENDING, and ERROR.

iv_clienttoken TYPE /AWS1/CWMSTRING /AWS1/CWMSTRING

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.

iv_maxcitynetworkstomonitor TYPE /AWS1/CWMMAXCITYNETWORKSTOMONI /AWS1/CWMMAXCITYNETWORKSTOMONI

The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.

io_internetmeasurementslog00 TYPE REF TO /AWS1/CL_CWMINTERNETMEASUREM00 /AWS1/CL_CWMINTERNETMEASUREM00

Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

iv_trafficpercentagetomoni TYPE /AWS1/CWMTRAFPERCENTAGETOMONI /AWS1/CWMTRAFPERCENTAGETOMONI

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

io_healtheventsconfig TYPE REF TO /AWS1/CL_CWMHEALTHEVENTSCONFIG /AWS1/CL_CWMHEALTHEVENTSCONFIG

The list of health score thresholds. A threshold percentage for health scores, along with other configuration information, determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_cwmupdatemonioutput /AWS1/CL_CWMUPDATEMONIOUTPUT

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->updatemonitor(
  io_healtheventsconfig = new /aws1/cl_cwmhealtheventsconfig(
    io_availabilitylocalhealth00 = new /aws1/cl_cwmlocalhealthevtscfg(
      iv_healthscorethreshold = '0.1'
      iv_mintrafficimpact = '0.1'
      iv_status = |string|
    )
    io_performancelocalhealthe00 = new /aws1/cl_cwmlocalhealthevtscfg(
      iv_healthscorethreshold = '0.1'
      iv_mintrafficimpact = '0.1'
      iv_status = |string|
    )
    iv_availabilityscorethresh = '0.1'
    iv_performancescorethreshold = '0.1'
  )
  io_internetmeasurementslog00 = new /aws1/cl_cwminternetmeasurem00(
    io_s3config = new /aws1/cl_cwms3config(
      iv_bucketname = |string|
      iv_bucketprefix = |string|
      iv_logdeliverystatus = |string|
    )
  )
  it_resourcestoadd = VALUE /aws1/cl_cwmsetofarns_w=>tt_setofarns(
    ( new /aws1/cl_cwmsetofarns_w( |string| ) )
  )
  it_resourcestoremove = VALUE /aws1/cl_cwmsetofarns_w=>tt_setofarns(
    ( new /aws1/cl_cwmsetofarns_w( |string| ) )
  )
  iv_clienttoken = |string|
  iv_maxcitynetworkstomonitor = 123
  iv_monitorname = |string|
  iv_status = |string|
  iv_trafficpercentagetomoni = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_monitorarn = lo_result->get_monitorarn( ).
  lv_monitorconfigstate = lo_result->get_status( ).
ENDIF.