AWS cli documentation change
Summary
Generalized documentation language from EKS-specific to multi-source configurations
Security assessment
Broadened scope of supported sources without introducing new security controls or vulnerabilities
Diff
diff --git a/cli/latest/reference/amp/create-scraper.md b/cli/latest/reference/amp/create-scraper.md index d74cd1989..169ec912c 100644 --- a//cli/latest/reference/amp/create-scraper.md +++ b//cli/latest/reference/amp/create-scraper.md @@ -15 +15 @@ - * [AWS CLI 2.31.32 Command Reference](../../index.html) » + * [AWS CLI 2.31.35 Command Reference](../../index.html) » @@ -59 +59 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -The `CreateScraper` operation creates a scraper to collect metrics. 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, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more. +The `CreateScraper` operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources and sends them to your Amazon Managed Service for Prometheus workspace. 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, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more. @@ -61 +61 @@ The `CreateScraper` operation creates a scraper to collect metrics. A scraper pu -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](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-eks-setup) in the _Amazon Managed Service for Prometheus User Guide_ . +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 [Configuring your Amazon EKS cluster](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-eks-setup) in the _Amazon Managed Service for Prometheus User Guide_ . @@ -65 +65 @@ The `scrapeConfiguration` parameter contains the base-64 encoded YAML configurat -When creating a scraper, the service creates a `Network Interface` in each **Availability Zone** that are passed into `CreateScraper` through subnets. These network interfaces are used to connect to the Amazon EKS cluster within the VPC for scraping metrics. +When creating a scraper, the service creates a `Network Interface` in each **Availability Zone** that are passed into `CreateScraper` through subnets. These network interfaces are used to connect to your source within the VPC for scraping metrics. @@ -148 +148 @@ JSON Syntax: -> The Amazon EKS cluster from which the scraper will collect metrics. +> The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics. @@ -152 +152 @@ JSON Syntax: -> This is a Tagged Union structure. Only one of the following top level keys can be set: `eksConfiguration`. +> This is a Tagged Union structure. Only one of the following top level keys can be set: `eksConfiguration`, `vpcConfiguration`. @@ -212,0 +213,50 @@ JSON Syntax: +> +> vpcConfiguration -> (structure) +> +>> The Amazon VPC configuration for the Prometheus collector when connecting to Amazon MSK clusters. This configuration enables secure, private network connectivity between the collector and your Amazon MSK cluster within your Amazon VPC. +>> +>> securityGroupIds -> (list) [required] +>> +>>> The security group IDs that control network access for the Prometheus collector. These security groups must allow the collector to communicate with your Amazon MSK cluster on the required ports. +>>> +>>> Constraints: +>>> +>>> * min: `1` +>>> * max: `5` +>>> + +>>> +>>> (string) +>>> +>>>> ID of a VPC security group. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `0` +>>>> * max: `255` +>>>> * pattern: `sg-[0-9a-z]+` +>>>> + +>> +>> subnetIds -> (list) [required] +>> +>>> The subnet IDs where the Prometheus collector will be deployed. The subnets must be in the same Amazon VPC as your Amazon MSK cluster and have network connectivity to the cluster. +>>> +>>> Constraints: +>>> +>>> * min: `1` +>>> * max: `5` +>>> + +>>> +>>> (string) +>>> +>>>> ID of a VPC subnet. +>>>> +>>>> Constraints: +>>>> +>>>> * min: `0` +>>>> * max: `255` +>>>> * pattern: `subnet-[0-9a-z]+` +>>>> + @@ -217 +267 @@ Shorthand Syntax: - eksConfiguration={clusterArn=string,securityGroupIds=[string,string],subnetIds=[string,string]} + eksConfiguration={clusterArn=string,securityGroupIds=[string,string],subnetIds=[string,string]},vpcConfiguration={securityGroupIds=[string,string],subnetIds=[string,string]} @@ -227,0 +278,4 @@ JSON Syntax: + }, + "vpcConfiguration": { + "securityGroupIds": ["string", ...], + "subnetIds": ["string", ...] @@ -549 +603 @@ tags -> (map) - * [AWS CLI 2.31.32 Command Reference](../../index.html) » + * [AWS CLI 2.31.35 Command Reference](../../index.html) »