Skip to content

CreateScraperRequest

Source code in docs_src/capo_amp/types/create_scraper_request.py
class CreateScraperRequest(TypedDict, closed=True):
    alias: NotRequired["capo_amp.types.scraper_alias.ScraperAlias"]
    """<p>(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.</p>"""
    scrape_configuration: "capo_amp.types.scrape_configuration.ScrapeConfiguration"
    """<p>The configuration file to use in the new scraper. For more information, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration">Scraper configuration</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p>"""
    source: "capo_amp.types.source.Source"
    """<p>The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics.</p>"""
    destination: "capo_amp.types.destination.Destination"
    """<p>The destination where the scraper sends the collected metrics. Valid destinations are Amazon Managed Service for Prometheus workspaces and CloudWatch datasets.</p>"""
    role_configuration: NotRequired[
        "capo_amp.types.role_configuration.RoleConfiguration"
    ]
    """<p>Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.</p>"""
    client_token: NotRequired["capo_amp.types.idempotency_token.IdempotencyToken"]
    """<p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.</p>"""
    tags: NotRequired["capo_amp.types.tag_map.TagMap"]
    """<p>(Optional) The list of tag keys and values to associate with the scraper.</p>"""
    exporters: NotRequired["capo_amp.types.exporter_list.ExporterList"]
    """<p>The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the scraper is created without an exporter configuration.</p>"""

alias instance-attribute

alias: NotRequired[ScraperAlias]

(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

destination instance-attribute

destination: Destination

The destination where the scraper sends the collected metrics. Valid destinations are Amazon Managed Service for Prometheus workspaces and CloudWatch datasets.

exporters instance-attribute

exporters: NotRequired[ExporterList]

The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the scraper is created without an exporter configuration.

role_configuration instance-attribute

role_configuration: NotRequired[RoleConfiguration]

Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.

scrape_configuration instance-attribute

scrape_configuration: ScrapeConfiguration

The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

source instance-attribute

source: Source

The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics.

tags instance-attribute

tags: NotRequired[TagMap]

(Optional) The list of tag keys and values to associate with the scraper.