Package software.amazon.awscdk.cfnpropertymixins.services.aps

Class CfnScraperPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.aps.CfnScraperPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:56.038Z") @Stability(Stable) public class CfnScraperPropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.aps.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnScraperPropsMixin cfnScraperPropsMixin = CfnScraperPropsMixin.Builder.create(CfnScraperMixinProps.builder()
         .alias("alias")
         .destination(DestinationProperty.builder()
                 .ampConfiguration(AmpConfigurationProperty.builder()
                         .workspaceArn("workspaceArn")
                         .build())
                 .build())
         .roleConfiguration(RoleConfigurationProperty.builder()
                 .sourceRoleArn("sourceRoleArn")
                 .targetRoleArn("targetRoleArn")
                 .build())
         .scrapeConfiguration(ScrapeConfigurationProperty.builder()
                 .configurationBlob("configurationBlob")
                 .build())
         .scraperLoggingConfiguration(ScraperLoggingConfigurationProperty.builder()
                 .loggingDestination(ScraperLoggingDestinationProperty.builder()
                         .cloudWatchLogs(CloudWatchLogDestinationProperty.builder()
                                 .logGroupArn("logGroupArn")
                                 .build())
                         .build())
                 .scraperComponents(List.of(ScraperComponentProperty.builder()
                         .config(ComponentConfigProperty.builder()
                                 .options(Map.of(
                                         "optionsKey", "options"))
                                 .build())
                         .type("type")
                         .build()))
                 .build())
         .source(SourceProperty.builder()
                 .eksConfiguration(EksConfigurationProperty.builder()
                         .clusterArn("clusterArn")
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnetIds(List.of("subnetIds"))
                         .build())
                 .vpcConfiguration(VpcConfigurationProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnetIds(List.of("subnetIds"))
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnScraperPropsMixin

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

    • CfnScraperPropsMixin

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

    • CfnScraperPropsMixin

      @Stability(Stable) public CfnScraperPropsMixin(@NotNull CfnScraperMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::APS::Scraper.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnScraperPropsMixin

      @Stability(Stable) public CfnScraperPropsMixin(@NotNull CfnScraperMixinProps props)
      Create a mixin to apply properties to AWS::APS::Scraper.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnScraperMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()