LogMetricFilter class

Provides a CloudWatch Log Metric Filter resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const dada = new aws.cloudwatch.LogGroup("dada", {name: "MyApp/access.log"});
const yada = new aws.cloudwatch.LogMetricFilter("yada", {
    metricTransformation: {
        name: "EventCount",
        namespace: "YourNamespace",
        value: "1",
    },
    name: "MyAppAccessCount",
    pattern: "",
    logGroupName: dada.name,
});
import pulumi
import pulumi_aws as aws

dada = aws.cloudwatch.LogGroup("dada", name="MyApp/access.log")
yada = aws.cloudwatch.LogMetricFilter("yada",
    metric_transformation={
        "name": "EventCount",
        "namespace": "YourNamespace",
        "value": "1",
    },
    name="MyAppAccessCount",
    pattern="",
    log_group_name=dada.name)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var dada = new Aws.CloudWatch.LogGroup("dada", new()
    {
        Name = "MyApp/access.log",
    });

    var yada = new Aws.CloudWatch.LogMetricFilter("yada", new()
    {
        MetricTransformation = new Aws.CloudWatch.Inputs.LogMetricFilterMetricTransformationArgs
        {
            Name = "EventCount",
            Namespace = "YourNamespace",
            Value = "1",
        },
        Name = "MyAppAccessCount",
        Pattern = "",
        LogGroupName = dada.Name,
    });

});
package main

import (
	"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 {
		dada, err := cloudwatch.NewLogGroup(ctx, "dada", &cloudwatch.LogGroupArgs{
			Name: pulumi.String("MyApp/access.log"),
		})
		if err != nil {
			return err
		}
		_, err = cloudwatch.NewLogMetricFilter(ctx, "yada", &cloudwatch.LogMetricFilterArgs{
			MetricTransformation: &cloudwatch.LogMetricFilterMetricTransformationArgs{
				Name:      pulumi.String("EventCount"),
				Namespace: pulumi.String("YourNamespace"),
				Value:     pulumi.String("1"),
			},
			Name:         pulumi.String("MyAppAccessCount"),
			Pattern:      pulumi.String(""),
			LogGroupName: dada.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cloudwatch_logmetricfilter" "yada" {
  metric_transformation = {
    name      = "EventCount"
    namespace = "YourNamespace"
    value     = "1"
  }
  name           = "MyAppAccessCount"
  pattern        = ""
  log_group_name = aws_cloudwatch_loggroup.dada.name
}
resource "aws_cloudwatch_loggroup" "dada" {
  name = "MyApp/access.log"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.LogGroup;
import com.pulumi.aws.cloudwatch.LogGroupArgs;
import com.pulumi.aws.cloudwatch.LogMetricFilter;
import com.pulumi.aws.cloudwatch.LogMetricFilterArgs;
import com.pulumi.aws.cloudwatch.inputs.LogMetricFilterMetricTransformationArgs;
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 dada = new LogGroup("dada", LogGroupArgs.builder()
            .name("MyApp/access.log")
            .build());

        var yada = new LogMetricFilter("yada", LogMetricFilterArgs.builder()
            .metricTransformation(LogMetricFilterMetricTransformationArgs.builder()
                .name("EventCount")
                .namespace("YourNamespace")
                .value("1")
                .build())
            .name("MyAppAccessCount")
            .pattern("")
            .logGroupName(dada.name())
            .build());

    }
}
resources:
  yada:
    type: aws:cloudwatch:LogMetricFilter
    properties:
      metricTransformation:
        name: EventCount
        namespace: YourNamespace
        value: '1'
      name: MyAppAccessCount
      pattern: ""
      logGroupName: ${dada.name}
  dada:
    type: aws:cloudwatch:LogGroup
    properties:
      name: MyApp/access.log

Import

Identity Schema

Required

  • logGroupName (String) Name of the log group.
  • name (String) Name of the metric filter.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import Metric Filters using logGroupName and name separated by a colon (:). For example:

$ pulumi import aws:cloudwatch/logMetricFilter:LogMetricFilter example example-group:example-filter

Constructors

LogMetricFilter(String name, {LogMetricFilterArgs? args, CustomResourceOptions? options})
Creates a new LogMetricFilter. name The Pulumi resource name. args Arguments used to configure this LogMetricFilter. The set of arguments for LogMetricFilter. options Resource options controlling this resource's behavior.
LogMetricFilter.reference(String urn)
Creates a typed reference to an existing LogMetricFilter resource.

Properties

applyOnTransformedLogs ↔ Output<bool>
Whether the metric filter will be applied on the transformed version of the log events instead of the original ingested log events. Defaults to false. Valid only for log groups that have an active log transformer.
latefinal
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
logGroupName ↔ Output<String>
The name of the log group to associate the metric filter with.
latefinal
metricTransformation ↔ Output<LogMetricFilterMetricTransformation>
A block defining collection of information needed to define how metric data gets emitted. See below.
latefinal
name ↔ Output<String>
A name for the metric filter.
latefinal
pattern ↔ Output<String>
A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.
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
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, {LogMetricFilterState? state, CustomResourceOptions? options}) → LogMetricFilter
Gets an existing LogMetricFilter resource's state with the given name and id.