|
129 | 129 | {"shape":"InternalServerException"}, |
130 | 130 | {"shape":"ServiceQuotaExceededException"} |
131 | 131 | ], |
132 | | - "documentation":"<p>Creates a scraper to collect metrics from Prometheus-compatible sources. The scraper sends the collected metrics to Amazon Managed Service for Prometheus workspaces or CloudWatch datasets. You can configure scrapers to collect metrics from Amazon EKS clusters, Amazon MSK clusters, or from VPC-based sources that support DNS-based service discovery. Scrapers are flexible. You can configure a scraper to control which metrics to collect, the frequency of collection, which transformations to apply to the metrics, and more.</p> <p>An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your source. You must configure this role with a policy that allows it to scrape metrics from your source. For Amazon EKS sources, see <a href=\"https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-eks-setup\">Configuring your Amazon EKS cluster</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p> <p>The <code>scrapeConfiguration</code> parameter contains the base-64 encoded YAML configuration for the scraper.</p> <p>When creating a scraper, the service creates a <code>Network Interface</code> in each <b>Availability Zone</b> that are passed into <code>CreateScraper</code> through subnets. These network interfaces are used to connect to your source within the VPC for scraping metrics.</p> <note> <p>For more information about collectors, including what metrics are collected, and how to configure the scraper, see <a href=\"https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html\">Using an Amazon Web Services managed collector</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p> </note>", |
| 132 | + "documentation":"<p>Creates a scraper to collect metrics from Prometheus-compatible sources. The scraper sends the collected metrics to Amazon Managed Service for Prometheus workspaces or CloudWatch datasets. You can configure scrapers to collect metrics from Amazon EKS clusters, Amazon MSK clusters, or from VPC-based sources that support DNS-based service discovery. Scrapers are flexible. You can configure a scraper to control which metrics to collect, the frequency of collection, which transformations to apply to the metrics, and more.</p> <p>An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your source. You must configure this role with a policy that allows it to scrape metrics from your source. For Amazon EKS sources, see <a href=\"https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-eks-setup\">Configuring your Amazon EKS cluster</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>. For a Kafka exporter, grant this role access with a cluster policy on the Amazon MSK cluster instead. For details, see <code>KafkaExporterConfiguration</code>.</p> <p>The <code>scrapeConfiguration</code> parameter contains the base-64 encoded YAML configuration for the scraper.</p> <p>When creating a scraper, the service creates a <code>Network Interface</code> in each <b>Availability Zone</b> that are passed into <code>CreateScraper</code> through subnets. These network interfaces are used to connect to your source within the VPC for scraping metrics.</p> <note> <p>For more information about collectors, including what metrics are collected, and how to configure the scraper, see <a href=\"https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html\">Using an Amazon Web Services managed collector</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p> </note>", |
133 | 133 | "idempotent":true |
134 | 134 | }, |
135 | 135 | "CreateWorkspace":{ |
|
1482 | 1482 | }, |
1483 | 1483 | "exporters":{ |
1484 | 1484 | "shape":"ExporterList", |
1485 | | - "documentation":"<p>The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the scraper is created without an exporter configuration.</p>" |
| 1485 | + "documentation":"<p>The exporter configurations for the scraper. You can configure at most one exporter, for either an Amazon OpenSearch Service domain or an Amazon MSK cluster. If you don't specify a value, the scraper is created without an exporter configuration.</p>" |
1486 | 1486 | } |
1487 | 1487 | }, |
1488 | 1488 | "documentation":"<p>Represents the input of a <code>CreateScraper</code> operation.</p>" |
|
2111 | 2111 | "openSearchConfiguration":{ |
2112 | 2112 | "shape":"OpenSearchExporterConfiguration", |
2113 | 2113 | "documentation":"<p>The configuration that the scraper uses to export metrics to an Amazon OpenSearch Service domain.</p>" |
| 2114 | + }, |
| 2115 | + "kafkaConfiguration":{ |
| 2116 | + "shape":"KafkaExporterConfiguration", |
| 2117 | + "documentation":"<p>The configuration that the scraper uses to collect metrics from an Amazon MSK cluster through a managed Kafka exporter.</p>" |
2114 | 2118 | } |
2115 | 2119 | }, |
2116 | 2120 | "documentation":"<p>Contains the configuration for an exporter managed by the scraper.</p>", |
|
2119 | 2123 | "ExporterList":{ |
2120 | 2124 | "type":"list", |
2121 | 2125 | "member":{"shape":"ExporterConfiguration"}, |
2122 | | - "documentation":"<p>A list of exporter configurations for a scraper. You can configure at most one Amazon OpenSearch Service domain.</p>", |
| 2126 | + "documentation":"<p>A list of exporter configurations for a scraper. You can configure at most one exporter, for either an Amazon OpenSearch Service domain or an Amazon MSK cluster.</p>", |
2123 | 2127 | "max":1, |
2124 | 2128 | "min":0 |
2125 | 2129 | }, |
|
2220 | 2224 | "fault":true, |
2221 | 2225 | "retryable":{"throttling":false} |
2222 | 2226 | }, |
| 2227 | + "KafkaExporterConfiguration":{ |
| 2228 | + "type":"structure", |
| 2229 | + "required":["clusterArn"], |
| 2230 | + "members":{ |
| 2231 | + "clusterArn":{ |
| 2232 | + "shape":"MskClusterArn", |
| 2233 | + "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon MSK cluster.</p>" |
| 2234 | + }, |
| 2235 | + "topicFilter":{ |
| 2236 | + "shape":"KafkaExporterFilter", |
| 2237 | + "documentation":"<p>An anchored RE2 regular expression that selects the Kafka topics to monitor. The expression must start with <code>^</code> and end with <code>$</code>. If omitted, the default is <code>^.*$</code>, which selects all topics.</p>" |
| 2238 | + }, |
| 2239 | + "consumerGroupFilter":{ |
| 2240 | + "shape":"KafkaExporterFilter", |
| 2241 | + "documentation":"<p>An anchored RE2 regular expression that selects the Kafka consumer groups to monitor. The expression must start with <code>^</code> and end with <code>$</code>. If omitted, the default is <code>^.*$</code>, which selects all consumer groups.</p>" |
| 2242 | + } |
| 2243 | + }, |
| 2244 | + "documentation":"<p>The configuration for collecting broker, topic, and consumer-group metrics from an Amazon MSK cluster through a managed Kafka exporter. The cluster must be active, have IAM authentication enabled, and be in the same account and Region as the scraper. Provisioned clusters with Standard brokers are supported. MSK Serverless clusters are not supported.</p> <p>Use a VPC source that can connect to the cluster's IAM bootstrap brokers. The exporter authenticates with the scraper's service-linked role. Metrics can be sent to an Amazon Managed Service for Prometheus workspace or a CloudWatch dataset.</p> <p>You must have an Amazon MSK cluster policy that grants the scraper's service-linked role access to the cluster. Without this policy, the scraper collects no Kafka metrics. For the required actions and example policies, see <a href=\"https://docs.aws.amazon.com/prometheus/latest/userguide/prom-msk-kafka-exporter.html#prom-msk-kafka-exporter-access\">Grant the scraper access to the cluster</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p>" |
| 2245 | + }, |
| 2246 | + "KafkaExporterFilter":{ |
| 2247 | + "type":"string", |
| 2248 | + "documentation":"<p>An anchored RE2 regular expression of 1 to 256 characters used by the managed Kafka exporter. Control characters are not allowed.</p>", |
| 2249 | + "max":256, |
| 2250 | + "min":1 |
| 2251 | + }, |
2223 | 2252 | "KmsKeyArn":{ |
2224 | 2253 | "type":"string", |
2225 | 2254 | "documentation":"<p>A KMS Key ARN.</p>", |
|
2595 | 2624 | "box":true, |
2596 | 2625 | "min":0 |
2597 | 2626 | }, |
| 2627 | + "MskClusterArn":{ |
| 2628 | + "type":"string", |
| 2629 | + "documentation":"<p>An Amazon Resource Name (ARN) that identifies an Amazon MSK cluster.</p>", |
| 2630 | + "pattern":"arn:aws[-a-z]*:kafka:[-a-z0-9]+:[0-9]{12}:cluster\\/.+" |
| 2631 | + }, |
2598 | 2632 | "OpenSearchDomainArn":{ |
2599 | 2633 | "type":"string", |
2600 | 2634 | "documentation":"<p>An Amazon Resource Name (ARN) that identifies an Amazon OpenSearch Service domain.</p>", |
|
3231 | 3265 | }, |
3232 | 3266 | "exporters":{ |
3233 | 3267 | "shape":"ExporterList", |
3234 | | - "documentation":"<p>The exporter configurations for the scraper, if configured. The list contains at most one configuration for an Amazon OpenSearch Service domain.</p>" |
| 3268 | + "documentation":"<p>The exporter configurations for the scraper, if configured. The list contains at most one configuration, for either an Amazon OpenSearch Service domain or an Amazon MSK cluster.</p>" |
3235 | 3269 | } |
3236 | 3270 | }, |
3237 | 3271 | "documentation":"<p>The <code>ScraperDescription</code> structure contains the full details about one scraper in your account.</p>" |
|
3381 | 3415 | }, |
3382 | 3416 | "exporters":{ |
3383 | 3417 | "shape":"ExporterList", |
3384 | | - "documentation":"<p>The exporter configurations for the scraper, if configured. The list contains at most one configuration for an Amazon OpenSearch Service domain.</p>" |
| 3418 | + "documentation":"<p>The exporter configurations for the scraper, if configured. The list contains at most one configuration, for either an Amazon OpenSearch Service domain or an Amazon MSK cluster.</p>" |
3385 | 3419 | } |
3386 | 3420 | }, |
3387 | 3421 | "documentation":"<p>The <code>ScraperSummary</code> structure contains a summary of the details about one scraper in your account.</p>" |
|
3730 | 3764 | }, |
3731 | 3765 | "exporters":{ |
3732 | 3766 | "shape":"ExporterList", |
3733 | | - "documentation":"<p>The exporter configurations for the scraper. You can configure at most one Amazon OpenSearch Service domain. If you don't specify a value, the existing exporter configuration remains unchanged.</p>" |
| 3767 | + "documentation":"<p>The exporter configurations for the scraper. You can configure at most one exporter, for either an Amazon OpenSearch Service domain or an Amazon MSK cluster. If you don't specify a value, the existing exporter configuration remains unchanged. Specify an empty list to remove the exporter.</p>" |
3734 | 3768 | } |
3735 | 3769 | } |
3736 | 3770 | }, |
|
0 commit comments