/AWS1/CL_AMP=>CREATESCRAPER()
¶
About CreateScraper¶
The CreateScraper
operation creates a scraper to collect metrics. A
scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS
cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the
scraper to control what metrics are collected, and what transformations are applied
prior to sending them to your workspace.
If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User Guide.
You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one.
The scrapeConfiguration
parameter contains the base64-encoded version of
the YAML configuration file.
For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors in the Amazon Managed Service for Prometheus User Guide.
Method Signature¶
IMPORTING¶
Required arguments:¶
IO_SCRAPECONFIGURATION
TYPE REF TO /AWS1/CL_AMPSCRAPECONF
/AWS1/CL_AMPSCRAPECONF
¶
The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
IO_SOURCE
TYPE REF TO /AWS1/CL_AMPSOURCE
/AWS1/CL_AMPSOURCE
¶
The Amazon EKS cluster from which the scraper will collect metrics.
IO_DESTINATION
TYPE REF TO /AWS1/CL_AMPDESTINATION
/AWS1/CL_AMPDESTINATION
¶
The Amazon Managed Service for Prometheus workspace to send metrics to.
Optional arguments:¶
IV_ALIAS
TYPE /AWS1/AMPSCRAPERALIAS
/AWS1/AMPSCRAPERALIAS
¶
(optional) a name to associate with the scraper. This is for your use, and does not need to be unique.
IV_CLIENTTOKEN
TYPE /AWS1/AMPIDEMPOTENCYTOKEN
/AWS1/AMPIDEMPOTENCYTOKEN
¶
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
IT_TAGS
TYPE /AWS1/CL_AMPTAGMAP_W=>TT_TAGMAP
TT_TAGMAP
¶
(Optional) The list of tag keys and values to associate with the scraper.