Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. aps
  5. Scraper

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.aps.Scraper

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::APS::Scraper

Create Scraper Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Scraper(name: string, args: ScraperArgs, opts?: CustomResourceOptions);
@overload
def Scraper(resource_name: str,
            args: ScraperArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Scraper(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            destination: Optional[ScraperDestinationArgs] = None,
            scrape_configuration: Optional[ScraperScrapeConfigurationArgs] = None,
            source: Optional[ScraperSourceArgs] = None,
            alias: Optional[str] = None,
            role_configuration: Optional[ScraperRoleConfigurationArgs] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewScraper(ctx *Context, name string, args ScraperArgs, opts ...ResourceOption) (*Scraper, error)
public Scraper(string name, ScraperArgs args, CustomResourceOptions? opts = null)
public Scraper(String name, ScraperArgs args)
public Scraper(String name, ScraperArgs args, CustomResourceOptions options)

type: aws-native:aps:Scraper
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ScraperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ScraperArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ScraperArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ScraperArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ScraperArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Scraper Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Scraper resource accepts the following input properties:

Destination This property is required. Pulumi.AwsNative.Aps.Inputs.ScraperDestination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
ScrapeConfiguration This property is required. Pulumi.AwsNative.Aps.Inputs.ScraperScrapeConfiguration
The configuration in use by the scraper.
Source This property is required. Pulumi.AwsNative.Aps.Inputs.ScraperSource
The Amazon EKS cluster from which the scraper collects metrics.
Alias string
Scraper alias.
RoleConfiguration Pulumi.AwsNative.Aps.Inputs.ScraperRoleConfiguration
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
Destination This property is required. ScraperDestinationArgs
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
ScrapeConfiguration This property is required. ScraperScrapeConfigurationArgs
The configuration in use by the scraper.
Source This property is required. ScraperSourceArgs
The Amazon EKS cluster from which the scraper collects metrics.
Alias string
Scraper alias.
RoleConfiguration ScraperRoleConfigurationArgs
Tags TagArgs
An array of key-value pairs to apply to this resource.
destination This property is required. ScraperDestination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
scrapeConfiguration This property is required. ScraperScrapeConfiguration
The configuration in use by the scraper.
source This property is required. ScraperSource
The Amazon EKS cluster from which the scraper collects metrics.
alias String
Scraper alias.
roleConfiguration ScraperRoleConfiguration
tags List<Tag>
An array of key-value pairs to apply to this resource.
destination This property is required. ScraperDestination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
scrapeConfiguration This property is required. ScraperScrapeConfiguration
The configuration in use by the scraper.
source This property is required. ScraperSource
The Amazon EKS cluster from which the scraper collects metrics.
alias string
Scraper alias.
roleConfiguration ScraperRoleConfiguration
tags Tag[]
An array of key-value pairs to apply to this resource.
destination This property is required. ScraperDestinationArgs
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
scrape_configuration This property is required. ScraperScrapeConfigurationArgs
The configuration in use by the scraper.
source This property is required. ScraperSourceArgs
The Amazon EKS cluster from which the scraper collects metrics.
alias str
Scraper alias.
role_configuration ScraperRoleConfigurationArgs
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
destination This property is required. Property Map
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
scrapeConfiguration This property is required. Property Map
The configuration in use by the scraper.
source This property is required. Property Map
The Amazon EKS cluster from which the scraper collects metrics.
alias String
Scraper alias.
roleConfiguration Property Map
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Scraper resource produces the following output properties:

Arn string
Scraper ARN.
Id string
The provider-assigned unique ID for this managed resource.
RoleArn string
IAM role ARN for the scraper.
ScraperId string
Required to identify a specific scraper.
Arn string
Scraper ARN.
Id string
The provider-assigned unique ID for this managed resource.
RoleArn string
IAM role ARN for the scraper.
ScraperId string
Required to identify a specific scraper.
arn String
Scraper ARN.
id String
The provider-assigned unique ID for this managed resource.
roleArn String
IAM role ARN for the scraper.
scraperId String
Required to identify a specific scraper.
arn string
Scraper ARN.
id string
The provider-assigned unique ID for this managed resource.
roleArn string
IAM role ARN for the scraper.
scraperId string
Required to identify a specific scraper.
arn str
Scraper ARN.
id str
The provider-assigned unique ID for this managed resource.
role_arn str
IAM role ARN for the scraper.
scraper_id str
Required to identify a specific scraper.
arn String
Scraper ARN.
id String
The provider-assigned unique ID for this managed resource.
roleArn String
IAM role ARN for the scraper.
scraperId String
Required to identify a specific scraper.

Supporting Types

ScraperDestination
, ScraperDestinationArgs

AmpConfiguration Pulumi.AwsNative.Aps.Inputs.ScraperDestinationAmpConfigurationProperties
Configuration for Amazon Managed Prometheus metrics destination
AmpConfiguration ScraperDestinationAmpConfigurationProperties
Configuration for Amazon Managed Prometheus metrics destination
ampConfiguration ScraperDestinationAmpConfigurationProperties
Configuration for Amazon Managed Prometheus metrics destination
ampConfiguration ScraperDestinationAmpConfigurationProperties
Configuration for Amazon Managed Prometheus metrics destination
amp_configuration ScraperDestinationAmpConfigurationProperties
Configuration for Amazon Managed Prometheus metrics destination
ampConfiguration Property Map
Configuration for Amazon Managed Prometheus metrics destination

ScraperDestinationAmpConfigurationProperties
, ScraperDestinationAmpConfigurationPropertiesArgs

WorkspaceArn This property is required. string
ARN of an Amazon Managed Prometheus workspace
WorkspaceArn This property is required. string
ARN of an Amazon Managed Prometheus workspace
workspaceArn This property is required. String
ARN of an Amazon Managed Prometheus workspace
workspaceArn This property is required. string
ARN of an Amazon Managed Prometheus workspace
workspace_arn This property is required. str
ARN of an Amazon Managed Prometheus workspace
workspaceArn This property is required. String
ARN of an Amazon Managed Prometheus workspace

ScraperRoleConfiguration
, ScraperRoleConfigurationArgs

SourceRoleArn string
IAM Role in source account
TargetRoleArn string
IAM Role in the target account
SourceRoleArn string
IAM Role in source account
TargetRoleArn string
IAM Role in the target account
sourceRoleArn String
IAM Role in source account
targetRoleArn String
IAM Role in the target account
sourceRoleArn string
IAM Role in source account
targetRoleArn string
IAM Role in the target account
source_role_arn str
IAM Role in source account
target_role_arn str
IAM Role in the target account
sourceRoleArn String
IAM Role in source account
targetRoleArn String
IAM Role in the target account

ScraperScrapeConfiguration
, ScraperScrapeConfigurationArgs

ConfigurationBlob string
Prometheus compatible scrape configuration in base64 encoded blob format
ConfigurationBlob string
Prometheus compatible scrape configuration in base64 encoded blob format
configurationBlob String
Prometheus compatible scrape configuration in base64 encoded blob format
configurationBlob string
Prometheus compatible scrape configuration in base64 encoded blob format
configuration_blob str
Prometheus compatible scrape configuration in base64 encoded blob format
configurationBlob String
Prometheus compatible scrape configuration in base64 encoded blob format

ScraperSource
, ScraperSourceArgs

EksConfiguration ScraperSourceEksConfigurationProperties
Configuration for EKS metrics source
eksConfiguration ScraperSourceEksConfigurationProperties
Configuration for EKS metrics source
eksConfiguration ScraperSourceEksConfigurationProperties
Configuration for EKS metrics source
eksConfiguration Property Map
Configuration for EKS metrics source

ScraperSourceEksConfigurationProperties
, ScraperSourceEksConfigurationPropertiesArgs

ClusterArn This property is required. string
ARN of an EKS cluster
SubnetIds This property is required. List<string>
List of subnet IDs
SecurityGroupIds List<string>
List of security group IDs
ClusterArn This property is required. string
ARN of an EKS cluster
SubnetIds This property is required. []string
List of subnet IDs
SecurityGroupIds []string
List of security group IDs
clusterArn This property is required. String
ARN of an EKS cluster
subnetIds This property is required. List<String>
List of subnet IDs
securityGroupIds List<String>
List of security group IDs
clusterArn This property is required. string
ARN of an EKS cluster
subnetIds This property is required. string[]
List of subnet IDs
securityGroupIds string[]
List of security group IDs
cluster_arn This property is required. str
ARN of an EKS cluster
subnet_ids This property is required. Sequence[str]
List of subnet IDs
security_group_ids Sequence[str]
List of security group IDs
clusterArn This property is required. String
ARN of an EKS cluster
subnetIds This property is required. List<String>
List of subnet IDs
securityGroupIds List<String>
List of security group IDs

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native