aws-cdk-lib 2.137.0__py3-none-any.whl → 2.139.0__py3-none-any.whl

aws_cdk/aws_aps/__init__.py

@@ -103,7 +103,7 @@ class CfnRuleGroupsNamespace(
         :param id: Construct identifier for this resource (unique in its scope).
         :param data: The rules file used in the namespace. For more details about the rules file, see `Creating a rules file <https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-ruler-rulesfile.html>`_ in the *Amazon Managed Service for Prometheus User Guide* .
         :param name: The name of the rule groups namespace.
-        :param workspace: An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
+        :param workspace: The ID of the workspace to add the rule groups namespace.
         :param tags: The list of tag keys and values that are associated with the rule groups namespace.
         '''
         if __debug__:
@@ -197,7 +197,7 @@ class CfnRuleGroupsNamespace(
     @builtins.property
     @jsii.member(jsii_name="workspace")
     def workspace(self) -> builtins.str:
-        '''An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.'''
+        '''The ID of the workspace to add the rule groups namespace.'''
         return typing.cast(builtins.str, jsii.get(self, "workspace"))
 
     @workspace.setter
@@ -244,7 +244,7 @@ class CfnRuleGroupsNamespaceProps:
 
         :param data: The rules file used in the namespace. For more details about the rules file, see `Creating a rules file <https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-ruler-rulesfile.html>`_ in the *Amazon Managed Service for Prometheus User Guide* .
         :param name: The name of the rule groups namespace.
-        :param workspace: An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
+        :param workspace: The ID of the workspace to add the rule groups namespace.
         :param tags: The list of tag keys and values that are associated with the rule groups namespace.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-rulegroupsnamespace.html
@@ -306,7 +306,7 @@ class CfnRuleGroupsNamespaceProps:
 
     @builtins.property
     def workspace(self) -> builtins.str:
-        '''An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
+        '''The ID of the workspace to add the rule groups namespace.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-rulegroupsnamespace.html#cfn-aps-rulegroupsnamespace-workspace
         '''
@@ -341,7 +341,16 @@ class CfnScraper(
     metaclass=jsii.JSIIMeta,
     jsii_type="aws-cdk-lib.aws_aps.CfnScraper",
 ):
-    '''Resource Type definition for AWS::APS::Scraper.
+    '''A scraper is a fully-managed agentless collector that discovers and pulls metrics automatically.
+
+    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. You can configure the scraper to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.
+
+    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* .
+
+    The ``scrapeConfiguration`` parameter contains the YAML configuration for the scraper.
+    .. epigraph::
+
+       For more information about collectors, including what metrics are collected, and how to configure the scraper, see `Using an AWS managed collector <https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html>`_ in the *Amazon Managed Service for Prometheus User Guide* .
 
     :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html
     :cloudformationResource: AWS::APS::Scraper
@@ -395,11 +404,11 @@ class CfnScraper(
         '''
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
-        :param destination: Scraper metrics destination.
-        :param scrape_configuration: Scraper configuration.
-        :param source: Scraper metrics source.
-        :param alias: Scraper alias.
-        :param tags: An array of key-value pairs to apply to this resource.
+        :param destination: The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
+        :param scrape_configuration: The configuration in use by the scraper.
+        :param source: The Amazon EKS cluster from which the scraper collects metrics.
+        :param alias: An optional user-assigned scraper alias.
+        :param tags: (Optional) The list of tag keys and values associated with the scraper.
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__4d4cb1653b22b80f73c5fa4972418519c1d58f8ac033d22184f1b74ee25bf2b0)
@@ -448,7 +457,9 @@ class CfnScraper(
     @builtins.property
     @jsii.member(jsii_name="attrArn")
     def attr_arn(self) -> builtins.str:
-        '''Scraper ARN.
+        '''The Amazon Resource Name (ARN) of the scraper.
+
+        For example, ``arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34`` .
 
         :cloudformationAttribute: Arn
         '''
@@ -457,7 +468,9 @@ class CfnScraper(
     @builtins.property
     @jsii.member(jsii_name="attrRoleArn")
     def attr_role_arn(self) -> builtins.str:
-        '''IAM role ARN for the scraper.
+        '''The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
+
+        For example, ``arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example`` .
 
         :cloudformationAttribute: RoleArn
         '''
@@ -466,7 +479,9 @@ class CfnScraper(
     @builtins.property
     @jsii.member(jsii_name="attrScraperId")
     def attr_scraper_id(self) -> builtins.str:
-        '''Required to identify a specific scraper.
+        '''The ID of the scraper.
+
+        For example, ``s-example1-1234-abcd-5678-ef9012abcd34`` .
 
         :cloudformationAttribute: ScraperId
         '''
@@ -488,7 +503,7 @@ class CfnScraper(
     def destination(
         self,
     ) -> typing.Union[_IResolvable_da3f097b, "CfnScraper.DestinationProperty"]:
-        '''Scraper metrics destination.'''
+        '''The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.'''
         return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnScraper.DestinationProperty"], jsii.get(self, "destination"))
 
     @destination.setter
@@ -506,7 +521,7 @@ class CfnScraper(
     def scrape_configuration(
         self,
     ) -> typing.Union[_IResolvable_da3f097b, "CfnScraper.ScrapeConfigurationProperty"]:
-        '''Scraper configuration.'''
+        '''The configuration in use by the scraper.'''
         return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnScraper.ScrapeConfigurationProperty"], jsii.get(self, "scrapeConfiguration"))
 
     @scrape_configuration.setter
@@ -524,7 +539,7 @@ class CfnScraper(
     def source(
         self,
     ) -> typing.Union[_IResolvable_da3f097b, "CfnScraper.SourceProperty"]:
-        '''Scraper metrics source.'''
+        '''The Amazon EKS cluster from which the scraper collects metrics.'''
         return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnScraper.SourceProperty"], jsii.get(self, "source"))
 
     @source.setter
@@ -540,7 +555,7 @@ class CfnScraper(
     @builtins.property
     @jsii.member(jsii_name="alias")
     def alias(self) -> typing.Optional[builtins.str]:
-        '''Scraper alias.'''
+        '''An optional user-assigned scraper alias.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "alias"))
 
     @alias.setter
@@ -553,7 +568,7 @@ class CfnScraper(
     @builtins.property
     @jsii.member(jsii_name="tags")
     def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
-        '''An array of key-value pairs to apply to this resource.'''
+        '''(Optional) The list of tag keys and values associated with the scraper.'''
         return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
 
     @tags.setter
@@ -570,9 +585,9 @@ class CfnScraper(
     )
     class AmpConfigurationProperty:
         def __init__(self, *, workspace_arn: builtins.str) -> None:
-            '''Configuration for Amazon Managed Prometheus metrics destination.
+            '''The ``AmpConfiguration`` structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.
 
-            :param workspace_arn: ARN of an Amazon Managed Prometheus workspace.
+            :param workspace_arn: ARN of the Amazon Managed Service for Prometheus workspace.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-ampconfiguration.html
             :exampleMetadata: fixture=_generated
@@ -596,7 +611,7 @@ class CfnScraper(
 
         @builtins.property
         def workspace_arn(self) -> builtins.str:
-            '''ARN of an Amazon Managed Prometheus workspace.
+            '''ARN of the Amazon Managed Service for Prometheus workspace.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-ampconfiguration.html#cfn-aps-scraper-ampconfiguration-workspacearn
             '''
@@ -626,9 +641,9 @@ class CfnScraper(
             *,
             amp_configuration: typing.Union[_IResolvable_da3f097b, typing.Union["CfnScraper.AmpConfigurationProperty", typing.Dict[builtins.str, typing.Any]]],
         ) -> None:
-            '''Scraper metrics destination.
+            '''Where to send the metrics from a scraper.
 
-            :param amp_configuration: Configuration for Amazon Managed Prometheus metrics destination.
+            :param amp_configuration: The Amazon Managed Service for Prometheus workspace to send metrics to.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-destination.html
             :exampleMetadata: fixture=_generated
@@ -656,7 +671,7 @@ class CfnScraper(
         def amp_configuration(
             self,
         ) -> typing.Union[_IResolvable_da3f097b, "CfnScraper.AmpConfigurationProperty"]:
-            '''Configuration for Amazon Managed Prometheus metrics destination.
+            '''The Amazon Managed Service for Prometheus workspace to send metrics to.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-destination.html#cfn-aps-scraper-destination-ampconfiguration
             '''
@@ -692,11 +707,11 @@ class CfnScraper(
             subnet_ids: typing.Sequence[builtins.str],
             security_group_ids: typing.Optional[typing.Sequence[builtins.str]] = None,
         ) -> None:
-            '''Configuration for EKS metrics source.
+            '''The ``EksConfiguration`` structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.
 
-            :param cluster_arn: ARN of an EKS cluster.
-            :param subnet_ids: List of subnet IDs.
-            :param security_group_ids: List of security group IDs.
+            :param cluster_arn: ARN of the Amazon EKS cluster.
+            :param subnet_ids: A list of subnet IDs for the Amazon EKS cluster VPC configuration.
+            :param security_group_ids: A list of the security group IDs for the Amazon EKS cluster VPC configuration.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-eksconfiguration.html
             :exampleMetadata: fixture=_generated
@@ -729,7 +744,7 @@ class CfnScraper(
 
         @builtins.property
         def cluster_arn(self) -> builtins.str:
-            '''ARN of an EKS cluster.
+            '''ARN of the Amazon EKS cluster.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-eksconfiguration.html#cfn-aps-scraper-eksconfiguration-clusterarn
             '''
@@ -739,7 +754,7 @@ class CfnScraper(
 
         @builtins.property
         def subnet_ids(self) -> typing.List[builtins.str]:
-            '''List of subnet IDs.
+            '''A list of subnet IDs for the Amazon EKS cluster VPC configuration.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-eksconfiguration.html#cfn-aps-scraper-eksconfiguration-subnetids
             '''
@@ -749,7 +764,7 @@ class CfnScraper(
 
         @builtins.property
         def security_group_ids(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''List of security group IDs.
+            '''A list of the security group IDs for the Amazon EKS cluster VPC configuration.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-eksconfiguration.html#cfn-aps-scraper-eksconfiguration-securitygroupids
             '''
@@ -774,9 +789,11 @@ class CfnScraper(
     )
     class ScrapeConfigurationProperty:
         def __init__(self, *, configuration_blob: builtins.str) -> None:
-            '''Scraper configuration.
+            '''A scrape configuration for a scraper, base 64 encoded.
+
+            For more information, see `Scraper configuration <https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration>`_ in the *Amazon Managed Service for Prometheus User Guide* .
 
-            :param configuration_blob: Prometheus compatible scrape configuration in base64 encoded blob format.
+            :param configuration_blob: The base 64 encoded scrape configuration file.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scrapeconfiguration.html
             :exampleMetadata: fixture=_generated
@@ -800,7 +817,7 @@ class CfnScraper(
 
         @builtins.property
         def configuration_blob(self) -> builtins.str:
-            '''Prometheus compatible scrape configuration in base64 encoded blob format.
+            '''The base 64 encoded scrape configuration file.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-scrapeconfiguration.html#cfn-aps-scraper-scrapeconfiguration-configurationblob
             '''
@@ -830,9 +847,9 @@ class CfnScraper(
             *,
             eks_configuration: typing.Union[_IResolvable_da3f097b, typing.Union["CfnScraper.EksConfigurationProperty", typing.Dict[builtins.str, typing.Any]]],
         ) -> None:
-            '''Scraper metrics source.
+            '''The source of collected metrics for a scraper.
 
-            :param eks_configuration: Configuration for EKS metrics source.
+            :param eks_configuration: The Amazon EKS cluster from which a scraper collects metrics.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-source.html
             :exampleMetadata: fixture=_generated
@@ -864,7 +881,7 @@ class CfnScraper(
         def eks_configuration(
             self,
         ) -> typing.Union[_IResolvable_da3f097b, "CfnScraper.EksConfigurationProperty"]:
-            '''Configuration for EKS metrics source.
+            '''The Amazon EKS cluster from which a scraper collects metrics.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-scraper-source.html#cfn-aps-scraper-source-eksconfiguration
             '''
@@ -907,11 +924,11 @@ class CfnScraperProps:
     ) -> None:
         '''Properties for defining a ``CfnScraper``.
 
-        :param destination: Scraper metrics destination.
-        :param scrape_configuration: Scraper configuration.
-        :param source: Scraper metrics source.
-        :param alias: Scraper alias.
-        :param tags: An array of key-value pairs to apply to this resource.
+        :param destination: The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
+        :param scrape_configuration: The configuration in use by the scraper.
+        :param source: The Amazon EKS cluster from which the scraper collects metrics.
+        :param alias: An optional user-assigned scraper alias.
+        :param tags: (Optional) The list of tag keys and values associated with the scraper.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html
         :exampleMetadata: fixture=_generated
@@ -970,7 +987,7 @@ class CfnScraperProps:
     def destination(
         self,
     ) -> typing.Union[_IResolvable_da3f097b, CfnScraper.DestinationProperty]:
-        '''Scraper metrics destination.
+        '''The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-destination
         '''
@@ -982,7 +999,7 @@ class CfnScraperProps:
     def scrape_configuration(
         self,
     ) -> typing.Union[_IResolvable_da3f097b, CfnScraper.ScrapeConfigurationProperty]:
-        '''Scraper configuration.
+        '''The configuration in use by the scraper.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-scrapeconfiguration
         '''
@@ -992,7 +1009,7 @@ class CfnScraperProps:
 
     @builtins.property
     def source(self) -> typing.Union[_IResolvable_da3f097b, CfnScraper.SourceProperty]:
-        '''Scraper metrics source.
+        '''The Amazon EKS cluster from which the scraper collects metrics.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-source
         '''
@@ -1002,7 +1019,7 @@ class CfnScraperProps:
 
     @builtins.property
     def alias(self) -> typing.Optional[builtins.str]:
-        '''Scraper alias.
+        '''An optional user-assigned scraper alias.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-alias
         '''
@@ -1011,7 +1028,7 @@ class CfnScraperProps:
 
     @builtins.property
     def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
-        '''An array of key-value pairs to apply to this resource.
+        '''(Optional) The list of tag keys and values associated with the scraper.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-tags
         '''