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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.aps.getScraper

Explore with Pulumi AI

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::APS::Scraper

Using getScraper

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getScraper(args: GetScraperArgs, opts?: InvokeOptions): Promise<GetScraperResult>
function getScraperOutput(args: GetScraperOutputArgs, opts?: InvokeOptions): Output<GetScraperResult>
Copy
def get_scraper(arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetScraperResult
def get_scraper_output(arn: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetScraperResult]
Copy
func LookupScraper(ctx *Context, args *LookupScraperArgs, opts ...InvokeOption) (*LookupScraperResult, error)
func LookupScraperOutput(ctx *Context, args *LookupScraperOutputArgs, opts ...InvokeOption) LookupScraperResultOutput
Copy

> Note: This function is named LookupScraper in the Go SDK.

public static class GetScraper 
{
    public static Task<GetScraperResult> InvokeAsync(GetScraperArgs args, InvokeOptions? opts = null)
    public static Output<GetScraperResult> Invoke(GetScraperInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetScraperResult> getScraper(GetScraperArgs args, InvokeOptions options)
public static Output<GetScraperResult> getScraper(GetScraperArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:aps:getScraper
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn This property is required. string
Scraper ARN.
Arn This property is required. string
Scraper ARN.
arn This property is required. String
Scraper ARN.
arn This property is required. string
Scraper ARN.
arn This property is required. str
Scraper ARN.
arn This property is required. String
Scraper ARN.

getScraper Result

The following output properties are available:

Alias string
Scraper alias.
Arn string
Scraper ARN.
Destination Pulumi.AwsNative.Aps.Outputs.ScraperDestination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
RoleArn string
IAM role ARN for the scraper.
RoleConfiguration Pulumi.AwsNative.Aps.Outputs.ScraperRoleConfiguration
ScrapeConfiguration Pulumi.AwsNative.Aps.Outputs.ScraperScrapeConfiguration
The configuration in use by the scraper.
ScraperId string
Required to identify a specific scraper.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
Alias string
Scraper alias.
Arn string
Scraper ARN.
Destination ScraperDestination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
RoleArn string
IAM role ARN for the scraper.
RoleConfiguration ScraperRoleConfiguration
ScrapeConfiguration ScraperScrapeConfiguration
The configuration in use by the scraper.
ScraperId string
Required to identify a specific scraper.
Tags Tag
An array of key-value pairs to apply to this resource.
alias String
Scraper alias.
arn String
Scraper ARN.
destination ScraperDestination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
roleArn String
IAM role ARN for the scraper.
roleConfiguration ScraperRoleConfiguration
scrapeConfiguration ScraperScrapeConfiguration
The configuration in use by the scraper.
scraperId String
Required to identify a specific scraper.
tags List<Tag>
An array of key-value pairs to apply to this resource.
alias string
Scraper alias.
arn string
Scraper ARN.
destination ScraperDestination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
roleArn string
IAM role ARN for the scraper.
roleConfiguration ScraperRoleConfiguration
scrapeConfiguration ScraperScrapeConfiguration
The configuration in use by the scraper.
scraperId string
Required to identify a specific scraper.
tags Tag[]
An array of key-value pairs to apply to this resource.
alias str
Scraper alias.
arn str
Scraper ARN.
destination ScraperDestination
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
role_arn str
IAM role ARN for the scraper.
role_configuration ScraperRoleConfiguration
scrape_configuration ScraperScrapeConfiguration
The configuration in use by the scraper.
scraper_id str
Required to identify a specific scraper.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
alias String
Scraper alias.
arn String
Scraper ARN.
destination Property Map
The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
roleArn String
IAM role ARN for the scraper.
roleConfiguration Property Map
scrapeConfiguration Property Map
The configuration in use by the scraper.
scraperId String
Required to identify a specific scraper.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Supporting Types

ScraperDestination

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

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

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

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

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. 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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native