Interface CfnScraperProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnScraperProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:31.550Z")
@Stability(Stable)
public interface CfnScraperProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnScraper.
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.*;
CfnScraperProps cfnScraperProps = CfnScraperProps.builder()
.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnScraperPropsstatic final classAn implementation forCfnScraperProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnScraperProps.Builderbuilder()default StringgetAlias()An optional user-assigned scraper alias.The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.default ObjectThe role configuration in an Amazon Managed Service for Prometheus scraper.The configuration in use by the scraper.default ObjectThe definition of logging configuration in an Amazon Managed Service for Prometheus workspace.The Amazon EKS cluster from which the scraper collects metrics.getTags()(Optional) The list of tag keys and values associated with the scraper.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDestination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.Returns union: either
IResolvableorCfnScraper.DestinationProperty- See Also:
-
getScrapeConfiguration
The configuration in use by the scraper.Returns union: either
IResolvableorCfnScraper.ScrapeConfigurationProperty- See Also:
-
getSource
The Amazon EKS cluster from which the scraper collects metrics.Returns union: either
IResolvableorCfnScraper.SourceProperty- See Also:
-
getAlias
An optional user-assigned scraper alias.- See Also:
-
getRoleConfiguration
The role configuration in an Amazon Managed Service for Prometheus scraper.Returns union: either
IResolvableorCfnScraper.RoleConfigurationProperty- See Also:
-
getScraperLoggingConfiguration
The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.Returns union: either
IResolvableorCfnScraper.ScraperLoggingConfigurationProperty- See Also:
-
getTags
(Optional) The list of tag keys and values associated with the scraper.- See Also:
-
builder
- Returns:
- a
CfnScraperProps.BuilderofCfnScraperProps
-