Package software.amazon.awscdk.services.aps

Interface CfnScraperProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScraperProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:04.518Z")
@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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnScraperProps.Builder	A builder for CfnScraperProps
static final class	CfnScraperProps.Jsii$Proxy	An implementation for CfnScraperProps

Method Summary

Modifier and Type	Method	Description
static CfnScraperProps.Builder	builder()
default String	getAlias()	An optional user-assigned scraper alias.
Object	getDestination()	The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
Object	getScrapeConfiguration()	The configuration in use by the scraper.
Object	getSource()	The Amazon EKS cluster from which the scraper collects metrics.
default List<CfnTag>	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

@Stability(Stable)
@NotNull
Object getDestination()

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

See Also:

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

getScrapeConfiguration

@Stability(Stable)
@NotNull
Object getScrapeConfiguration()

The configuration in use by the scraper.

See Also:

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

getSource

@Stability(Stable)
@NotNull
Object getSource()

The Amazon EKS cluster from which the scraper collects metrics.

See Also:

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

getAlias

@Stability(Stable)
@Nullable
default String getAlias()

An optional user-assigned scraper alias.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

(Optional) The list of tag keys and values associated with the scraper.

See Also:

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

builder

@Stability(Stable)
static CfnScraperProps.Builder builder()

Returns:

a CfnScraperProps.Builder of CfnScraperProps