Package software.amazon.awscdk.services.aps

Class CfnScraper

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.aps.CfnScraper
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IScraperRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:34.687Z") @Stability(Stable) public class CfnScraper extends CfnResource implements IInspectable, IScraperRef, ITaggableV2
A scraper is a fully-managed agentless collector that discovers and pulls metrics automatically.

A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible. You can configure the scraper to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.

An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide .

The scrapeConfiguration parameter contains the YAML configuration for the scraper.

For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an AWS managed collector in the Amazon Managed Service for Prometheus User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.aps.*;
 CfnScraper cfnScraper = CfnScraper.Builder.create(this, "MyCfnScraper")
         .destination(DestinationProperty.builder()
                 .ampConfiguration(AmpConfigurationProperty.builder()
                         .workspaceArn("workspaceArn")
                         .build())
                 .build())
         .scrapeConfiguration(ScrapeConfigurationProperty.builder()
                 .configurationBlob("configurationBlob")
                 .build())
         .source(SourceProperty.builder()
                 .eksConfiguration(EksConfigurationProperty.builder()
                         .clusterArn("clusterArn")
                         .subnetIds(List.of("subnetIds"))
                         // the properties below are optional
                         .securityGroupIds(List.of("securityGroupIds"))
                         .build())
                 .build())
         // the properties below are optional
         .alias("alias")
         .roleConfiguration(RoleConfigurationProperty.builder()
                 .sourceRoleArn("sourceRoleArn")
                 .targetRoleArn("targetRoleArn")
                 .build())
         .scraperLoggingConfiguration(ScraperLoggingConfigurationProperty.builder()
                 .loggingDestination(ScraperLoggingDestinationProperty.builder()
                         .cloudWatchLogs(CloudWatchLogDestinationProperty.builder()
                                 .logGroupArn("logGroupArn")
                                 .build())
                         .build())
                 .scraperComponents(List.of(ScraperComponentProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .config(ComponentConfigProperty.builder()
                                 .options(Map.of(
                                         "optionsKey", "options"))
                                 .build())
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnScraper

      protected CfnScraper(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnScraper

      protected CfnScraper(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnScraper

      @Stability(Stable) public CfnScraper(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnScraperProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the scraper.

      For example, arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34 .

    • getAttrRoleArn

      @Stability(Stable) @NotNull public String getAttrRoleArn()
      The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

      For example, arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example .

    • getAttrScraperId

      @Stability(Stable) @NotNull public String getAttrScraperId()
      The ID of the scraper.

      For example, s-example1-1234-abcd-5678-ef9012abcd34 .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getScraperRef

      @Stability(Stable) @NotNull public ScraperReference getScraperRef()
      A reference to a Scraper resource.
      Specified by:
      getScraperRef in interface IScraperRef

    • getDestination

      @Stability(Stable) @NotNull public Object getDestination()
      The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

      Returns union: either IResolvable or CfnScraper.DestinationProperty

    • setDestination

      @Stability(Stable) public void setDestination(@NotNull IResolvable value)
      The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

    • setDestination

      @Stability(Stable) public void setDestination(@NotNull CfnScraper.DestinationProperty value)
      The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

    • getScrapeConfiguration

      @Stability(Stable) @NotNull public Object getScrapeConfiguration()
      The configuration in use by the scraper.

      Returns union: either IResolvable or CfnScraper.ScrapeConfigurationProperty

    • setScrapeConfiguration

      @Stability(Stable) public void setScrapeConfiguration(@NotNull IResolvable value)
      The configuration in use by the scraper.

    • setScrapeConfiguration

      @Stability(Stable) public void setScrapeConfiguration(@NotNull CfnScraper.ScrapeConfigurationProperty value)
      The configuration in use by the scraper.

    • getSource

      @Stability(Stable) @NotNull public Object getSource()
      The Amazon EKS cluster from which the scraper collects metrics.

      Returns union: either IResolvable or CfnScraper.SourceProperty

    • setSource

      @Stability(Stable) public void setSource(@NotNull IResolvable value)
      The Amazon EKS cluster from which the scraper collects metrics.

    • setSource

      @Stability(Stable) public void setSource(@NotNull CfnScraper.SourceProperty value)
      The Amazon EKS cluster from which the scraper collects metrics.

    • getAlias

      @Stability(Stable) @Nullable public String getAlias()
      An optional user-assigned scraper alias.

    • setAlias

      @Stability(Stable) public void setAlias(@Nullable String value)
      An optional user-assigned scraper alias.

    • getRoleConfiguration

      @Stability(Stable) @Nullable public Object getRoleConfiguration()
      The role configuration in an Amazon Managed Service for Prometheus scraper.

      Returns union: either IResolvable or CfnScraper.RoleConfigurationProperty

    • setRoleConfiguration

      @Stability(Stable) public void setRoleConfiguration(@Nullable IResolvable value)
      The role configuration in an Amazon Managed Service for Prometheus scraper.

    • setRoleConfiguration

      @Stability(Stable) public void setRoleConfiguration(@Nullable CfnScraper.RoleConfigurationProperty value)
      The role configuration in an Amazon Managed Service for Prometheus scraper.

    • getScraperLoggingConfiguration

      @Stability(Stable) @Nullable public Object getScraperLoggingConfiguration()
      The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

      Returns union: either IResolvable or CfnScraper.ScraperLoggingConfigurationProperty

    • setScraperLoggingConfiguration

      @Stability(Stable) public void setScraperLoggingConfiguration(@Nullable IResolvable value)
      The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

    • setScraperLoggingConfiguration

      @Stability(Stable) public void setScraperLoggingConfiguration(@Nullable CfnScraper.ScraperLoggingConfigurationProperty value)
      The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      (Optional) The list of tag keys and values associated with the scraper.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      (Optional) The list of tag keys and values associated with the scraper.