Skip to content
v2.274.0

CfnScraperProps Struct ​

Properties for defining a CfnScraper.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_aps as aps } from 'aws-cdk-lib';
const cfnScraperProps: aps.CfnScraperProps = {
  destination: {
    ampConfiguration: {
      workspaceArn: 'workspaceArn',
    },
    cloudWatchConfiguration: {
      datasetArn: 'datasetArn',
    },
  },
  scrapeConfiguration: {
    configurationBlob: 'configurationBlob',
  },
  source: {
    eksConfiguration: {
      clusterArn: 'clusterArn',
      subnetIds: ['subnetIds'],

      // the properties below are optional
      securityGroupIds: ['securityGroupIds'],
    },
    vpcConfiguration: {
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
  },

  // the properties below are optional
  alias: 'alias',
  roleConfiguration: {
    sourceRoleArn: 'sourceRoleArn',
    targetRoleArn: 'targetRoleArn',
  },
  scraperLoggingConfiguration: {
    loggingDestination: {
      cloudWatchLogs: {
        logGroupArn: 'logGroupArn',
      },
    },
    scraperComponents: [{
      type: 'type',

      // the properties below are optional
      config: {
        options: {
          optionsKey: 'options',
        },
      },
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

aliasoptionalstringaliasoptionalstraliasoptionalStringAliasoptionalstringAliasoptional*string#
An optional user-assigned scraper alias.
destinationIResolvable | CfnScraper.DestinationPropertydestinationtyping.Union[IResolvable, DestinationProperty]destinationIResolvableDestinationIResolvableDestinationinterface{}required#
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
roleConfigurationoptionalIResolvable | CfnScraper.RoleConfigurationPropertyrole_configurationoptionaltyping.Union[IResolvable, RoleConfigurationProperty]roleConfigurationoptionalIResolvableRoleConfigurationoptionalIResolvableRoleConfigurationoptionalinterface{}#
The role configuration in an Amazon Managed Service for Prometheus scraper.
scrapeConfigurationIResolvable | CfnScraper.ScrapeConfigurationPropertyscrape_configurationtyping.Union[IResolvable, ScrapeConfigurationProperty]scrapeConfigurationIResolvableScrapeConfigurationIResolvableScrapeConfigurationinterface{}required#
The configuration in use by the scraper.
scraperLoggingConfigurationoptionalIResolvable | CfnScraper.ScraperLoggingConfigurationPropertyscraper_logging_configurationoptionaltyping.Union[IResolvable, ScraperLoggingConfigurationProperty]scraperLoggingConfigurationoptionalIResolvableScraperLoggingConfigurationoptionalIResolvableScraperLoggingConfigurationoptionalinterface{}#
The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
sourceIResolvable | CfnScraper.SourcePropertysourcetyping.Union[IResolvable, SourceProperty]sourceIResolvableSourceIResolvableSourceinterface{}required#
The Amazon EKS cluster from which the scraper collects metrics.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
(Optional) The list of tag keys and values associated with the scraper.