ScraperLoggingConfiguration class
Manages an Amazon Managed Service for Prometheus (AMP) Scraper Logging Configuration.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amp.Scraper("example", {
source: {
eks: {
clusterArn: exampleAwsEksCluster.arn,
subnetIds: exampleAwsSubnet.map(__item => __item.id),
},
},
destination: {
amp: {
workspaceArn: exampleAwsPrometheusWorkspace.arn,
},
},
scrapeConfiguration: `global:
scrape_interval: 15s
scrape_configs:
- job_name: 'prometheus'
static_configs:
- targets: ['localhost:9090']
`,
});
const exampleLogGroup = new aws.cloudwatch.LogGroup("example", {name: "/aws/prometheus/scraper-logs/example"});
const exampleScraperLoggingConfiguration = new aws.amp.ScraperLoggingConfiguration("example", {
loggingDestination: {
cloudwatchLogs: {
logGroupArn: pulumi.interpolate`${exampleLogGroup.arn}:*`,
},
},
scraperId: example.id,
});
import pulumi
import pulumi_aws as aws
example = aws.amp.Scraper("example",
source={
"eks": {
"cluster_arn": example_aws_eks_cluster["arn"],
"subnet_ids": [__item["id"] for __item in example_aws_subnet],
},
},
destination={
"amp": {
"workspace_arn": example_aws_prometheus_workspace["arn"],
},
},
scrape_configuration="""global:
scrape_interval: 15s
scrape_configs:
- job_name: 'prometheus'
static_configs:
- targets: ['localhost:9090']
""")
example_log_group = aws.cloudwatch.LogGroup("example", name="/aws/prometheus/scraper-logs/example")
example_scraper_logging_configuration = aws.amp.ScraperLoggingConfiguration("example",
logging_destination={
"cloudwatch_logs": {
"log_group_arn": example_log_group.arn.apply(lambda arn: f"{arn}:*"),
},
},
scraper_id=example.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amp.Scraper("example", new()
{
Source = new Aws.Amp.Inputs.ScraperSourceArgs
{
Eks = new Aws.Amp.Inputs.ScraperSourceEksArgs
{
ClusterArn = exampleAwsEksCluster.Arn,
SubnetIds = exampleAwsSubnet.Select(__item => __item.Id).ToList(),
},
},
Destination = new Aws.Amp.Inputs.ScraperDestinationArgs
{
Amp = new Aws.Amp.Inputs.ScraperDestinationAmpArgs
{
WorkspaceArn = exampleAwsPrometheusWorkspace.Arn,
},
},
ScrapeConfiguration = @"global:
scrape_interval: 15s
scrape_configs:
- job_name: 'prometheus'
static_configs:
- targets: ['localhost:9090']
",
});
var exampleLogGroup = new Aws.CloudWatch.LogGroup("example", new()
{
Name = "/aws/prometheus/scraper-logs/example",
});
var exampleScraperLoggingConfiguration = new Aws.Amp.ScraperLoggingConfiguration("example", new()
{
LoggingDestination = new Aws.Amp.Inputs.ScraperLoggingConfigurationLoggingDestinationArgs
{
CloudwatchLogs = new Aws.Amp.Inputs.ScraperLoggingConfigurationLoggingDestinationCloudwatchLogsArgs
{
LogGroupArn = exampleLogGroup.Arn.Apply(arn => $"{arn}:*"),
},
},
ScraperId = example.Id,
});
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/amp"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := amp.NewScraper(ctx, "example", &.ScraperArgs{
Source: &.ScraperSourceArgs{
Eks: &.ScraperSourceEksArgs{
ClusterArn: pulumi.Any(exampleAwsEksCluster.Arn),
SubnetIds: pulumi.StringArray(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:4,20-42)),
},
},
Destination: &.ScraperDestinationArgs{
Amp: &.ScraperDestinationAmpArgs{
WorkspaceArn: pulumi.Any(exampleAwsPrometheusWorkspace.Arn),
},
},
ScrapeConfiguration: pulumi.String(`global:
scrape_interval: 15s
scrape_configs:
- job_name: 'prometheus'
static_configs:
- targets: ['localhost:9090']
`),
})
if err != nil {
return err
}
exampleLogGroup, err := cloudwatch.NewLogGroup(ctx, "example", &cloudwatch.LogGroupArgs{
Name: pulumi.String("/aws/prometheus/scraper-logs/example"),
})
if err != nil {
return err
}
_, err = amp.NewScraperLoggingConfiguration(ctx, "example", &.ScraperLoggingConfigurationArgs{
LoggingDestination: &.ScraperLoggingConfigurationLoggingDestinationArgs{
CloudwatchLogs: &.ScraperLoggingConfigurationLoggingDestinationCloudwatchLogsArgs{
LogGroupArn: exampleLogGroup.Arn.ApplyT(func(arn string) (string, error) {
return fmt.Sprintf("%v:*", arn), nil
}).(pulumi.StringOutput),
},
},
ScraperId: example.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_amp_scraper" "example" {
source = {
eks = {
cluster_arn = exampleAwsEksCluster.arn
subnet_ids = exampleAwsSubnet[*].id
}
}
destination = {
amp = {
workspace_arn = exampleAwsPrometheusWorkspace.arn
}
}
scrape_configuration = "global:\n scrape_interval: 15s\nscrape_configs:\n - job_name: 'prometheus'\n static_configs:\n - targets: ['localhost:9090']\n"
}
resource "aws_cloudwatch_loggroup" "example" {
name = "/aws/prometheus/scraper-logs/example"
}
resource "aws_amp_scraperloggingconfiguration" "example" {
logging_destination = {
cloudwatch_logs = {
log_group_arn ="${aws_cloudwatch_loggroup.example.arn}:*"
}
}
scraper_id = aws_amp_scraper.example.id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amp.Scraper;
import com.pulumi.aws.amp.ScraperArgs;
import com.pulumi.aws.amp.inputs.ScraperSourceArgs;
import com.pulumi.aws.amp.inputs.ScraperSourceEksArgs;
import com.pulumi.aws.amp.inputs.ScraperDestinationArgs;
import com.pulumi.aws.amp.inputs.ScraperDestinationAmpArgs;
import com.pulumi.aws.cloudwatch.LogGroup;
import com.pulumi.aws.cloudwatch.LogGroupArgs;
import com.pulumi.aws.amp.ScraperLoggingConfiguration;
import com.pulumi.aws.amp.ScraperLoggingConfigurationArgs;
import com.pulumi.aws.amp.inputs.ScraperLoggingConfigurationLoggingDestinationArgs;
import com.pulumi.aws.amp.inputs.ScraperLoggingConfigurationLoggingDestinationCloudwatchLogsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Scraper("example", ScraperArgs.builder()
.source(ScraperSourceArgs.builder()
.eks(ScraperSourceEksArgs.builder()
.clusterArn(exampleAwsEksCluster.arn())
.subnetIds(exampleAwsSubnet.stream().map(element -> element.id()).collect(toList()))
.build())
.build())
.destination(ScraperDestinationArgs.builder()
.amp(ScraperDestinationAmpArgs.builder()
.workspaceArn(exampleAwsPrometheusWorkspace.arn())
.build())
.build())
.scrapeConfiguration("""
global:
scrape_interval: 15s
scrape_configs:
- job_name: 'prometheus'
static_configs:
- targets: ['localhost:9090']
""")
.build());
var exampleLogGroup = new LogGroup("exampleLogGroup", LogGroupArgs.builder()
.name("/aws/prometheus/scraper-logs/example")
.build());
var exampleScraperLoggingConfiguration = new ScraperLoggingConfiguration("exampleScraperLoggingConfiguration", ScraperLoggingConfigurationArgs.builder()
.loggingDestination(ScraperLoggingConfigurationLoggingDestinationArgs.builder()
.cloudwatchLogs(ScraperLoggingConfigurationLoggingDestinationCloudwatchLogsArgs.builder()
.logGroupArn(exampleLogGroup.arn().applyValue(_arn -> String.format("%s:*", _arn)))
.build())
.build())
.scraperId(example.id())
.build());
}
}
With Scraper Components
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amp.ScraperLoggingConfiguration("example", {
loggingDestination: {
cloudwatchLogs: {
logGroupArn: `${exampleAwsCloudwatchLogGroup.arn}:*`,
},
},
scraperId: exampleAwsPrometheusScraper.id,
scraperComponents: [
"COLLECTOR",
"EXPORTER",
],
});
import pulumi
import pulumi_aws as aws
example = aws.amp.ScraperLoggingConfiguration("example",
logging_destination={
"cloudwatch_logs": {
"log_group_arn": f"{example_aws_cloudwatch_log_group['arn']}:*",
},
},
scraper_id=example_aws_prometheus_scraper["id"],
scraper_components=[
"COLLECTOR",
"EXPORTER",
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amp.ScraperLoggingConfiguration("example", new()
{
LoggingDestination = new Aws.Amp.Inputs.ScraperLoggingConfigurationLoggingDestinationArgs
{
CloudwatchLogs = new Aws.Amp.Inputs.ScraperLoggingConfigurationLoggingDestinationCloudwatchLogsArgs
{
LogGroupArn = $"{exampleAwsCloudwatchLogGroup.Arn}:*",
},
},
ScraperId = exampleAwsPrometheusScraper.Id,
ScraperComponents = new[]
{
"COLLECTOR",
"EXPORTER",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/amp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := amp.NewScraperLoggingConfiguration(ctx, "example", &.ScraperLoggingConfigurationArgs{
LoggingDestination: &.ScraperLoggingConfigurationLoggingDestinationArgs{
CloudwatchLogs: &.ScraperLoggingConfigurationLoggingDestinationCloudwatchLogsArgs{
LogGroupArn: pulumi.Sprintf("%v:*", exampleAwsCloudwatchLogGroup.Arn),
},
},
ScraperId: pulumi.Any(exampleAwsPrometheusScraper.Id),
ScraperComponents: pulumi.StringArray{
pulumi.String("COLLECTOR"),
pulumi.String("EXPORTER"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_amp_scraperloggingconfiguration" "example" {
logging_destination = {
cloudwatch_logs = {
log_group_arn ="${exampleAwsCloudwatchLogGroup.arn}:*"
}
}
scraper_id = exampleAwsPrometheusScraper.id
scraper_components = ["COLLECTOR", "EXPORTER"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amp.ScraperLoggingConfiguration;
import com.pulumi.aws.amp.ScraperLoggingConfigurationArgs;
import com.pulumi.aws.amp.inputs.ScraperLoggingConfigurationLoggingDestinationArgs;
import com.pulumi.aws.amp.inputs.ScraperLoggingConfigurationLoggingDestinationCloudwatchLogsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ScraperLoggingConfiguration("example", ScraperLoggingConfigurationArgs.builder()
.loggingDestination(ScraperLoggingConfigurationLoggingDestinationArgs.builder()
.cloudwatchLogs(ScraperLoggingConfigurationLoggingDestinationCloudwatchLogsArgs.builder()
.logGroupArn(String.format("%s:*", exampleAwsCloudwatchLogGroup.arn()))
.build())
.build())
.scraperId(exampleAwsPrometheusScraper.id())
.scraperComponents(
"COLLECTOR",
"EXPORTER")
.build());
}
}
resources:
example:
type: aws:amp:ScraperLoggingConfiguration
properties:
loggingDestination:
cloudwatchLogs:
logGroupArn: ${exampleAwsCloudwatchLogGroup.arn}:*
scraperId: ${exampleAwsPrometheusScraper.id}
scraperComponents:
- COLLECTOR
- EXPORTER
Import
Identity Schema
Required
scraperId(String) ID of the scraper.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import scraper logging configurations using scraperId. For example:
$ pulumi import aws:amp/scraperLoggingConfiguration:ScraperLoggingConfiguration example s-b6f487db-4761-4930-9215-e9d588a7efe2
Constructors
- ScraperLoggingConfiguration(String name, {ScraperLoggingConfigurationArgs? args, CustomResourceOptions? options})
-
Creates a new ScraperLoggingConfiguration.
nameThe Pulumi resource name.argsArguments used to configure this ScraperLoggingConfiguration. The set of arguments for ScraperLoggingConfiguration.optionsResource options controlling this resource's behavior. - ScraperLoggingConfiguration.reference(String urn)
- Creates a typed reference to an existing ScraperLoggingConfiguration resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
loggingDestination
↔ Output<
ScraperLoggingConfigurationLoggingDestination> -
Configuration block for the logging destination. See
loggingDestinationBlock below.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scraperComponents
↔ Output<
List< String> > -
Scraper components to log. Valid values:
COLLECTOR,EXPORTER,SERVICE_DISCOVERY.latefinal -
scraperId
↔ Output<
String> -
ID of the scraper to configure logging for.
latefinal
-
timeouts
↔ Output<
ScraperLoggingConfigurationTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ScraperLoggingConfigurationState? state, CustomResourceOptions? options}) → ScraperLoggingConfiguration -
Gets an existing ScraperLoggingConfiguration resource's state with the given
nameandid.