|
1718 | 1718 | } |
1719 | 1719 | ], |
1720 | 1720 | "traits": { |
1721 | | - "smithy.api#documentation": "<p>The <code>CreateRuleGroupsNamespace</code> operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.</p> <p>Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use <code>PutRuleGroupsNamespace</code>.</p>", |
| 1721 | + "smithy.api#documentation": "<p>The <code>CreateRuleGroupsNamespace</code> operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.</p> <important> <p>The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.</p> </important> <p>Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use <code>PutRuleGroupsNamespace</code>.</p>", |
1722 | 1722 | "smithy.api#http": { |
1723 | 1723 | "code": 202, |
1724 | 1724 | "method": "POST", |
|
1837 | 1837 | } |
1838 | 1838 | ], |
1839 | 1839 | "traits": { |
1840 | | - "smithy.api#documentation": "<p>The <code>CreateScraper</code> 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.</p> <p>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 <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 the Amazon EKS cluster 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>", |
| 1840 | + "smithy.api#documentation": "<p>The <code>CreateScraper</code> 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.</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>", |
1841 | 1841 | "smithy.api#examples": [ |
1842 | 1842 | { |
1843 | 1843 | "title": "CreateScraper with optional alias input, optional clientToken input, and one set of tags", |
|
1877 | 1877 | "exampleTag": "exampleValue" |
1878 | 1878 | } |
1879 | 1879 | } |
| 1880 | + }, |
| 1881 | + { |
| 1882 | + "title": "CreateScraper with generic VPC config with mandatory securityGroupIds and subnetIds", |
| 1883 | + "input": { |
| 1884 | + "alias": "alias", |
| 1885 | + "scrapeConfiguration": { |
| 1886 | + "configurationBlob": "blob" |
| 1887 | + }, |
| 1888 | + "source": { |
| 1889 | + "vpcConfiguration": { |
| 1890 | + "securityGroupIds": [ |
| 1891 | + "sg-abc123" |
| 1892 | + ], |
| 1893 | + "subnetIds": [ |
| 1894 | + "subnet-abc123" |
| 1895 | + ] |
| 1896 | + } |
| 1897 | + }, |
| 1898 | + "destination": { |
| 1899 | + "ampConfiguration": { |
| 1900 | + "workspaceArn": "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234" |
| 1901 | + } |
| 1902 | + }, |
| 1903 | + "clientToken": "token", |
| 1904 | + "tags": { |
| 1905 | + "exampleTag": "exampleValue" |
| 1906 | + } |
| 1907 | + }, |
| 1908 | + "output": { |
| 1909 | + "scraperId": "scraper-123", |
| 1910 | + "arn": "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123", |
| 1911 | + "status": { |
| 1912 | + "statusCode": "CREATING" |
| 1913 | + }, |
| 1914 | + "tags": { |
| 1915 | + "exampleTag": "exampleValue" |
| 1916 | + } |
| 1917 | + } |
1880 | 1918 | } |
1881 | 1919 | ], |
1882 | 1920 | "smithy.api#http": { |
|
1906 | 1944 | "source": { |
1907 | 1945 | "target": "com.amazonaws.amp#Source", |
1908 | 1946 | "traits": { |
1909 | | - "smithy.api#documentation": "<p>The Amazon EKS cluster from which the scraper will collect metrics.</p>", |
| 1947 | + "smithy.api#documentation": "<p>The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics.</p>", |
1910 | 1948 | "smithy.api#required": {} |
1911 | 1949 | } |
1912 | 1950 | }, |
|
5057 | 5095 | } |
5058 | 5096 | ], |
5059 | 5097 | "traits": { |
5060 | | - "smithy.api#documentation": "<p>Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.</p> <p>Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use <code>CreateRuleGroupsNamespace</code>.</p> <p>You can't use this operation to add tags to an existing rule groups namespace. Instead, use <code>TagResource</code>.</p>", |
| 5098 | + "smithy.api#documentation": "<p>Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.</p> <important> <p>The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.</p> </important> <p>Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use <code>CreateRuleGroupsNamespace</code>.</p> <p>You can't use this operation to add tags to an existing rule groups namespace. Instead, use <code>TagResource</code>.</p>", |
5061 | 5099 | "smithy.api#http": { |
5062 | 5100 | "code": 202, |
5063 | 5101 | "method": "PUT", |
|
6199 | 6237 | "traits": { |
6200 | 6238 | "smithy.api#documentation": "<p>The Amazon EKS cluster from which a scraper collects metrics.</p>" |
6201 | 6239 | } |
| 6240 | + }, |
| 6241 | + "vpcConfiguration": { |
| 6242 | + "target": "com.amazonaws.amp#VpcConfiguration", |
| 6243 | + "traits": { |
| 6244 | + "smithy.api#documentation": "<p>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.</p>" |
| 6245 | + } |
6202 | 6246 | } |
6203 | 6247 | }, |
6204 | 6248 | "traits": { |
|
7096 | 7140 | ] |
7097 | 7141 | } |
7098 | 7142 | }, |
| 7143 | + "com.amazonaws.amp#VpcConfiguration": { |
| 7144 | + "type": "structure", |
| 7145 | + "members": { |
| 7146 | + "securityGroupIds": { |
| 7147 | + "target": "com.amazonaws.amp#SecurityGroupIds", |
| 7148 | + "traits": { |
| 7149 | + "smithy.api#documentation": "<p>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.</p>", |
| 7150 | + "smithy.api#required": {} |
| 7151 | + } |
| 7152 | + }, |
| 7153 | + "subnetIds": { |
| 7154 | + "target": "com.amazonaws.amp#SubnetIds", |
| 7155 | + "traits": { |
| 7156 | + "smithy.api#documentation": "<p>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.</p>", |
| 7157 | + "smithy.api#required": {} |
| 7158 | + } |
| 7159 | + } |
| 7160 | + }, |
| 7161 | + "traits": { |
| 7162 | + "smithy.api#documentation": "<p>The Amazon VPC configuration that specifies the network settings for a Prometheus collector to securely connect to Amazon MSK clusters. This configuration includes the security groups and subnets that control network access and placement for the collector.</p>" |
| 7163 | + } |
| 7164 | + }, |
7099 | 7165 | "com.amazonaws.amp#Workspace": { |
7100 | 7166 | "type": "resource", |
7101 | 7167 | "identifiers": { |
|
0 commit comments