interface CfnScraperMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.APS.Mixins.CfnScraperMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsaps/mixins#CfnScraperMixinProps
Java	software.amazon.awscdk.mixins.preview.services.aps.mixins.CfnScraperMixinProps
Python	aws_cdk.mixins_preview.aws_aps.mixins.CfnScraperMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_aps » mixins » CfnScraperMixinProps

Properties for CfnScraperPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as aps_mixins } from '@aws-cdk/mixins-preview/aws-aps';
const cfnScraperMixinProps: aps_mixins.CfnScraperMixinProps = {
  alias: 'alias',
  destination: {
    ampConfiguration: {
      workspaceArn: 'workspaceArn',
    },
  },
  roleConfiguration: {
    sourceRoleArn: 'sourceRoleArn',
    targetRoleArn: 'targetRoleArn',
  },
  scrapeConfiguration: {
    configurationBlob: 'configurationBlob',
  },
  scraperLoggingConfiguration: {
    loggingDestination: {
      cloudWatchLogs: {
        logGroupArn: 'logGroupArn',
      },
    },
    scraperComponents: [{
      config: {
        options: {
          optionsKey: 'options',
        },
      },
      type: 'type',
    }],
  },
  source: {
    eksConfiguration: {
      clusterArn: 'clusterArn',
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
    vpcConfiguration: {
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
alias?	string	An optional user-assigned scraper alias.
destination?	IResolvable | DestinationProperty	The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
roleConfiguration?	IResolvable | RoleConfigurationProperty	The role configuration in an Amazon Managed Service for Prometheus scraper.
scrapeConfiguration?	IResolvable | ScrapeConfigurationProperty	The configuration in use by the scraper.
scraperLoggingConfiguration?	IResolvable | ScraperLoggingConfigurationProperty	The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
source?	IResolvable | SourceProperty	The Amazon EKS cluster from which the scraper collects metrics.
tags?	CfnTag[]	(Optional) The list of tag keys and values associated with the scraper.

---

alias?

Type: string (optional)

An optional user-assigned scraper alias.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-alias

---

destination?

Type: IResolvable | DestinationProperty (optional)

The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-destination

---

roleConfiguration?

Type: IResolvable | RoleConfigurationProperty (optional)

The role configuration in an Amazon Managed Service for Prometheus scraper.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-roleconfiguration

---

scrapeConfiguration?

Type: IResolvable | ScrapeConfigurationProperty (optional)

The configuration in use by the scraper.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-scrapeconfiguration

---

scraperLoggingConfiguration?

Type: IResolvable | ScraperLoggingConfigurationProperty (optional)

The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-scraperloggingconfiguration

---

source?

Type: IResolvable | SourceProperty (optional)

The Amazon EKS cluster from which the scraper collects metrics.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-source

---

tags?

Type: CfnTag[] (optional)

(Optional) The list of tag keys and values associated with the scraper.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-aps-scraper.html#cfn-aps-scraper-tags