feat(client-amp): Add VPC source configuration support enabling Amazon Managed Service for Prometheus Collector to collect metrics from MSK clusters.

Author: awstools

clients/client-amp/src/commands/CreateRuleGroupsNamespaceCommand.ts

@@ -27,7 +27,7 @@ export interface CreateRuleGroupsNamespaceCommandInput extends CreateRuleGroupsN
 export interface CreateRuleGroupsNamespaceCommandOutput extends CreateRuleGroupsNamespaceResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-amp/src/commands/CreateScraperCommand.ts

@@ -27,7 +27,7 @@ export interface CreateScraperCommandInput extends CreateScraperRequest {}
 export interface CreateScraperCommandOutput extends CreateScraperResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -51,6 +51,14 @@ export interface CreateScraperCommandOutput extends CreateScraperResponse, __Met
  *         "STRING_VALUE",
  *       ],
  *     },
+ *     vpcConfiguration: { // VpcConfiguration
+ *       securityGroupIds: [ // required
+ *         "STRING_VALUE",
+ *       ],
+ *       subnetIds: [ // required
+ *         "STRING_VALUE",
+ *       ],
+ *     },
  *   },
  *   destination: { // Destination Union: only one key present
  *     ampConfiguration: { // AmpConfiguration
@@ -157,6 +165,50 @@ export interface CreateScraperCommandOutput extends CreateScraperResponse, __Met
  * *\/
  * ```
  *
+ * @example CreateScraper with generic VPC config with mandatory securityGroupIds and subnetIds
+ * ```javascript
+ * //
+ * const input = {
+ *   alias: "alias",
+ *   clientToken: "token",
+ *   destination: {
+ *     ampConfiguration: {
+ *       workspaceArn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234"
+ *     }
+ *   },
+ *   scrapeConfiguration: {
+ *     configurationBlob: "blob"
+ *   },
+ *   source: {
+ *     vpcConfiguration: {
+ *       securityGroupIds: [
+ *         "sg-abc123"
+ *       ],
+ *       subnetIds: [
+ *         "subnet-abc123"
+ *       ]
+ *     }
+ *   },
+ *   tags: {
+ *     exampleTag: "exampleValue"
+ *   }
+ * };
+ * const command = new CreateScraperCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123",
+ *   scraperId: "scraper-123",
+ *   status: {
+ *     statusCode: "CREATING"
+ *   },
+ *   tags: {
+ *     exampleTag: "exampleValue"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export class CreateScraperCommand extends $Command

clients/client-amp/src/commands/DescribeScraperCommand.ts

@@ -69,6 +69,14 @@ export interface DescribeScraperCommandOutput extends DescribeScraperResponse, _
  * //           "STRING_VALUE",
  * //         ],
  * //       },
+ * //       vpcConfiguration: { // VpcConfiguration
+ * //         securityGroupIds: [ // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         subnetIds: [ // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
  * //     },
  * //     destination: { // Destination Union: only one key present
  * //       ampConfiguration: { // AmpConfiguration

clients/client-amp/src/commands/ListScrapersCommand.ts

@@ -73,6 +73,14 @@ export interface ListScrapersCommandOutput extends ListScrapersResponse, __Metad
  * //             "STRING_VALUE",
  * //           ],
  * //         },
+ * //         vpcConfiguration: { // VpcConfiguration
+ * //           securityGroupIds: [ // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           subnetIds: [ // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
  * //       },
  * //       destination: { // Destination Union: only one key present
  * //         ampConfiguration: { // AmpConfiguration

clients/client-amp/src/commands/PutRuleGroupsNamespaceCommand.ts

@@ -27,7 +27,7 @@ export interface PutRuleGroupsNamespaceCommandInput extends PutRuleGroupsNamespa
 export interface PutRuleGroupsNamespaceCommandOutput extends PutRuleGroupsNamespaceResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-amp/src/models/models_0.ts

@@ -644,11 +644,29 @@ export interface EksConfiguration {
   subnetIds: string[] | undefined;
 }
 
+/**
+ * <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>
+ * @public
+ */
+export interface VpcConfiguration {
+  /**
+   * <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>
+   * @public
+   */
+  securityGroupIds: string[] | undefined;
+
+  /**
+   * <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>
+   * @public
+   */
+  subnetIds: string[] | undefined;
+}
+
 /**
  * <p>The source of collected metrics for a scraper.</p>
  * @public
  */
-export type Source = Source.EksConfigurationMember | Source.$UnknownMember;
+export type Source = Source.EksConfigurationMember | Source.VpcConfigurationMember | Source.$UnknownMember;
 
 /**
  * @public
@@ -660,6 +678,17 @@ export namespace Source {
    */
   export interface EksConfigurationMember {
     eksConfiguration: EksConfiguration;
+    vpcConfiguration?: never;
+    $unknown?: never;
+  }
+
+  /**
+   * <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>
+   * @public
+   */
+  export interface VpcConfigurationMember {
+    eksConfiguration?: never;
+    vpcConfiguration: VpcConfiguration;
     $unknown?: never;
   }
 
@@ -668,6 +697,7 @@ export namespace Source {
    */
   export interface $UnknownMember {
     eksConfiguration?: never;
+    vpcConfiguration?: never;
     $unknown: [string, any];
   }
 
@@ -677,6 +707,7 @@ export namespace Source {
    */
   export interface Visitor<T> {
     eksConfiguration: (value: EksConfiguration) => T;
+    vpcConfiguration: (value: VpcConfiguration) => T;
     _: (name: string, value: any) => T;
   }
 }
@@ -699,7 +730,7 @@ export interface CreateScraperRequest {
   scrapeConfiguration: ScrapeConfiguration | undefined;
 
   /**
-   * <p>The Amazon EKS cluster from which the scraper will collect metrics.</p>
+   * <p>The Amazon EKS or Amazon Web Services cluster from which the scraper will collect metrics.</p>
    * @public
    */
   source: Source | undefined;

clients/client-amp/src/schemas/schemas_0.ts

@@ -169,6 +169,7 @@ const _UWAR = "UpdateWorkspaceAliasRequest";
 const _UWC = "UpdateWorkspaceConfiguration";
 const _UWCR = "UpdateWorkspaceConfigurationRequest";
 const _UWCRp = "UpdateWorkspaceConfigurationResponse";
+const _VC = "VpcConfiguration";
 const _VE = "ValidationException";
 const _VEF = "ValidationExceptionField";
 const _VEFL = "ValidationExceptionFieldList";
@@ -269,6 +270,7 @@ const _t = "tags";
 const _tK = "tagKeys";
 const _tRA = "targetRoleArn";
 const _ty = "type";
+const _vC = "vpcConfiguration";
 const _w = "workspace";
 const _wA = "workspaceArn";
 const _wC = "workspaceConfiguration";
@@ -1200,6 +1202,7 @@ export var ValidationException: StaticErrorSchema = [
 TypeRegistry.for(n0).registerError(ValidationException, __ValidationException);
 
 export var ValidationExceptionField: StaticStructureSchema = [3, n0, _VEF, 0, [_n, _m], [0, 0]];
+export var VpcConfiguration: StaticStructureSchema = [3, n0, _VC, 0, [_sGI, _sIu], [64 | 0, 64 | 0]];
 export var WorkspaceConfigurationDescription: StaticStructureSchema = [
   3,
   n0,
@@ -1276,7 +1279,7 @@ export var ScraperLoggingDestination: StaticStructureSchema = [
   [_cWL],
   [() => CloudWatchLogDestination],
 ];
-export var Source: StaticStructureSchema = [3, n0, _S, 0, [_eC], [() => EksConfiguration]];
+export var Source: StaticStructureSchema = [3, n0, _S, 0, [_eC, _vC], [() => EksConfiguration, () => VpcConfiguration]];
 export var CreateAlertManagerDefinition: StaticOperationSchema = [
   9,
   n0,