CfnScraperProps

class aws_cdk.aws_aps.CfnScraperProps(*, destination, scrape_configuration, source, alias=None, role_configuration=None, scraper_logging_configuration=None, tags=None)

Bases: object

Properties for defining a CfnScraper.

Parameters:

destination (Union[IResolvable, DestinationProperty, Dict[str, Any]]) – The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
scrape_configuration (Union[IResolvable, ScrapeConfigurationProperty, Dict[str, Any]]) – The configuration in use by the scraper.
source (Union[IResolvable, SourceProperty, Dict[str, Any]]) – The Amazon EKS cluster from which the scraper collects metrics.
alias (Optional[str]) – An optional user-assigned scraper alias.
role_configuration (Union[IResolvable, RoleConfigurationProperty, Dict[str, Any], None]) – The role configuration in an Amazon Managed Service for Prometheus scraper.
scraper_logging_configuration (Union[IResolvable, ScraperLoggingConfigurationProperty, Dict[str, Any], None]) – The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – (Optional) The list of tag keys and values associated with the scraper.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_aps as aps

cfn_scraper_props = aps.CfnScraperProps(
    destination=aps.CfnScraper.DestinationProperty(
        amp_configuration=aps.CfnScraper.AmpConfigurationProperty(
            workspace_arn="workspaceArn"
        )
    ),
    scrape_configuration=aps.CfnScraper.ScrapeConfigurationProperty(
        configuration_blob="configurationBlob"
    ),
    source=aps.CfnScraper.SourceProperty(
        eks_configuration=aps.CfnScraper.EksConfigurationProperty(
            cluster_arn="clusterArn",
            subnet_ids=["subnetIds"],

            # the properties below are optional
            security_group_ids=["securityGroupIds"]
        )
    ),

    # the properties below are optional
    alias="alias",
    role_configuration=aps.CfnScraper.RoleConfigurationProperty(
        source_role_arn="sourceRoleArn",
        target_role_arn="targetRoleArn"
    ),
    scraper_logging_configuration=aps.CfnScraper.ScraperLoggingConfigurationProperty(
        logging_destination=aps.CfnScraper.ScraperLoggingDestinationProperty(
            cloud_watch_logs=aps.CfnScraper.CloudWatchLogDestinationProperty(
                log_group_arn="logGroupArn"
            )
        ),
        scraper_components=[aps.CfnScraper.ScraperComponentProperty(
            type="type",

            # the properties below are optional
            config=aps.CfnScraper.ComponentConfigProperty(
                options={
                    "options_key": "options"
                }
            )
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)