CfnScraperMixinProps

class aws_cdk.mixins_preview.aws_aps.mixins.CfnScraperMixinProps(*, alias=None, destination=None, role_configuration=None, scrape_configuration=None, scraper_logging_configuration=None, source=None, tags=None)

Bases: object

Properties for CfnScraperPropsMixin.

Parameters:
  • alias (Optional[str]) – An optional user-assigned scraper alias.

  • destination (Union[IResolvable, DestinationProperty, Dict[str, Any], None]) – The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

  • role_configuration (Union[IResolvable, RoleConfigurationProperty, Dict[str, Any], None]) – The role configuration in an Amazon Managed Service for Prometheus scraper.

  • scrape_configuration (Union[IResolvable, ScrapeConfigurationProperty, Dict[str, Any], None]) – The configuration in use by the scraper.

  • scraper_logging_configuration (Union[IResolvable, ScraperLoggingConfigurationProperty, Dict[str, Any], None]) – The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

  • source (Union[IResolvable, SourceProperty, Dict[str, Any], None]) – The Amazon EKS cluster from which the scraper collects metrics.

  • 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.mixins_preview.aws_aps import mixins as aps_mixins

cfn_scraper_mixin_props = aps_mixins.CfnScraperMixinProps(
    alias="alias",
    destination=aps_mixins.CfnScraperPropsMixin.DestinationProperty(
        amp_configuration=aps_mixins.CfnScraperPropsMixin.AmpConfigurationProperty(
            workspace_arn="workspaceArn"
        )
    ),
    role_configuration=aps_mixins.CfnScraperPropsMixin.RoleConfigurationProperty(
        source_role_arn="sourceRoleArn",
        target_role_arn="targetRoleArn"
    ),
    scrape_configuration=aps_mixins.CfnScraperPropsMixin.ScrapeConfigurationProperty(
        configuration_blob="configurationBlob"
    ),
    scraper_logging_configuration=aps_mixins.CfnScraperPropsMixin.ScraperLoggingConfigurationProperty(
        logging_destination=aps_mixins.CfnScraperPropsMixin.ScraperLoggingDestinationProperty(
            cloud_watch_logs=aps_mixins.CfnScraperPropsMixin.CloudWatchLogDestinationProperty(
                log_group_arn="logGroupArn"
            )
        ),
        scraper_components=[aps_mixins.CfnScraperPropsMixin.ScraperComponentProperty(
            config=aps_mixins.CfnScraperPropsMixin.ComponentConfigProperty(
                options={
                    "options_key": "options"
                }
            ),
            type="type"
        )]
    ),
    source=aps_mixins.CfnScraperPropsMixin.SourceProperty(
        eks_configuration=aps_mixins.CfnScraperPropsMixin.EksConfigurationProperty(
            cluster_arn="clusterArn",
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        ),
        vpc_configuration=aps_mixins.CfnScraperPropsMixin.VpcConfigurationProperty(
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

alias

An optional user-assigned scraper alias.

See:

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

destination

The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

See:

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

role_configuration

The role configuration in an Amazon Managed Service for Prometheus scraper.

See:

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

scrape_configuration

The configuration in use by the scraper.

See:

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

scraper_logging_configuration

The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

See:

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

source

The Amazon EKS cluster from which the scraper collects metrics.

See:

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

tags

(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#cfn-aps-scraper-tags