AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

getMetricFilter

Specifies a metric filter that describes how CloudWatch Logs extracts information from logs and transforms it into Amazon CloudWatch metrics.

Using getMetricFilter

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 getMetricFilter(args: GetMetricFilterArgs, opts?: InvokeOptions): Promise<GetMetricFilterResult>
function getMetricFilterOutput(args: GetMetricFilterOutputArgs, opts?: InvokeOptions): Output<GetMetricFilterResult>
def get_metric_filter(filter_name: Optional[str] = None,
                      log_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetMetricFilterResult
def get_metric_filter_output(filter_name: Optional[pulumi.Input[str]] = None,
                      log_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetMetricFilterResult]
func LookupMetricFilter(ctx *Context, args *LookupMetricFilterArgs, opts ...InvokeOption) (*LookupMetricFilterResult, error)
func LookupMetricFilterOutput(ctx *Context, args *LookupMetricFilterOutputArgs, opts ...InvokeOption) LookupMetricFilterResultOutput

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

public static class GetMetricFilter 
{
    public static Task<GetMetricFilterResult> InvokeAsync(GetMetricFilterArgs args, InvokeOptions? opts = null)
    public static Output<GetMetricFilterResult> Invoke(GetMetricFilterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMetricFilterResult> getMetricFilter(GetMetricFilterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:logs:getMetricFilter
  Arguments:
    # Arguments dictionary

The following arguments are supported:

FilterName string

A name for the metric filter.

LogGroupName string

Existing log group that you want to associate with this filter.

FilterName string

A name for the metric filter.

LogGroupName string

Existing log group that you want to associate with this filter.

filterName String

A name for the metric filter.

logGroupName String

Existing log group that you want to associate with this filter.

filterName string

A name for the metric filter.

logGroupName string

Existing log group that you want to associate with this filter.

filter_name str

A name for the metric filter.

log_group_name str

Existing log group that you want to associate with this filter.

filterName String

A name for the metric filter.

logGroupName String

Existing log group that you want to associate with this filter.

getMetricFilter Result

The following output properties are available:

FilterPattern string

Pattern that Logs follows to interpret each entry in a log.

MetricTransformations List<Pulumi.AwsNative.Logs.Outputs.MetricFilterMetricTransformation>

A collection of information that defines how metric data gets emitted.

FilterPattern string

Pattern that Logs follows to interpret each entry in a log.

MetricTransformations []MetricFilterMetricTransformation

A collection of information that defines how metric data gets emitted.

filterPattern String

Pattern that Logs follows to interpret each entry in a log.

metricTransformations List<MetricFilterMetricTransformation>

A collection of information that defines how metric data gets emitted.

filterPattern string

Pattern that Logs follows to interpret each entry in a log.

metricTransformations MetricFilterMetricTransformation[]

A collection of information that defines how metric data gets emitted.

filter_pattern str

Pattern that Logs follows to interpret each entry in a log.

metric_transformations Sequence[MetricFilterMetricTransformation]

A collection of information that defines how metric data gets emitted.

filterPattern String

Pattern that Logs follows to interpret each entry in a log.

metricTransformations List<Property Map>

A collection of information that defines how metric data gets emitted.

Supporting Types

MetricFilterDimension

Key string

The key of the dimension. Maximum length of 255.

Value string

The value of the dimension. Maximum length of 255.

Key string

The key of the dimension. Maximum length of 255.

Value string

The value of the dimension. Maximum length of 255.

key String

The key of the dimension. Maximum length of 255.

value String

The value of the dimension. Maximum length of 255.

key string

The key of the dimension. Maximum length of 255.

value string

The value of the dimension. Maximum length of 255.

key str

The key of the dimension. Maximum length of 255.

value str

The value of the dimension. Maximum length of 255.

key String

The key of the dimension. Maximum length of 255.

value String

The value of the dimension. Maximum length of 255.

MetricFilterMetricTransformation

MetricName string

The name of the CloudWatch metric. Metric name must be in ASCII format.

MetricNamespace string

The namespace of the CloudWatch metric.

MetricValue string

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

DefaultValue double

The value to emit when a filter pattern does not match a log event. This value can be null.

Dimensions List<Pulumi.AwsNative.Logs.Inputs.MetricFilterDimension>

Dimensions are the key-value pairs that further define a metric

Unit Pulumi.AwsNative.Logs.MetricFilterMetricTransformationUnit

The unit to assign to the metric. If you omit this, the unit is set as None.

MetricName string

The name of the CloudWatch metric. Metric name must be in ASCII format.

MetricNamespace string

The namespace of the CloudWatch metric.

MetricValue string

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

DefaultValue float64

The value to emit when a filter pattern does not match a log event. This value can be null.

Dimensions []MetricFilterDimension

Dimensions are the key-value pairs that further define a metric

Unit MetricFilterMetricTransformationUnit

The unit to assign to the metric. If you omit this, the unit is set as None.

metricName String

The name of the CloudWatch metric. Metric name must be in ASCII format.

metricNamespace String

The namespace of the CloudWatch metric.

metricValue String

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

defaultValue Double

The value to emit when a filter pattern does not match a log event. This value can be null.

dimensions List<MetricFilterDimension>

Dimensions are the key-value pairs that further define a metric

unit MetricFilterMetricTransformationUnit

The unit to assign to the metric. If you omit this, the unit is set as None.

metricName string

The name of the CloudWatch metric. Metric name must be in ASCII format.

metricNamespace string

The namespace of the CloudWatch metric.

metricValue string

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

defaultValue number

The value to emit when a filter pattern does not match a log event. This value can be null.

dimensions MetricFilterDimension[]

Dimensions are the key-value pairs that further define a metric

unit MetricFilterMetricTransformationUnit

The unit to assign to the metric. If you omit this, the unit is set as None.

metric_name str

The name of the CloudWatch metric. Metric name must be in ASCII format.

metric_namespace str

The namespace of the CloudWatch metric.

metric_value str

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

default_value float

The value to emit when a filter pattern does not match a log event. This value can be null.

dimensions Sequence[MetricFilterDimension]

Dimensions are the key-value pairs that further define a metric

unit MetricFilterMetricTransformationUnit

The unit to assign to the metric. If you omit this, the unit is set as None.

metricName String

The name of the CloudWatch metric. Metric name must be in ASCII format.

metricNamespace String

The namespace of the CloudWatch metric.

metricValue String

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

defaultValue Number

The value to emit when a filter pattern does not match a log event. This value can be null.

dimensions List<Property Map>

Dimensions are the key-value pairs that further define a metric

unit "Seconds" | "Microseconds" | "Milliseconds" | "Bytes" | "Kilobytes" | "Megabytes" | "Gigabytes" | "Terabytes" | "Bits" | "Kilobits" | "Megabits" | "Gigabits" | "Terabits" | "Percent" | "Count" | "Bytes/Second" | "Kilobytes/Second" | "Megabytes/Second" | "Gigabytes/Second" | "Terabytes/Second" | "Bits/Second" | "Kilobits/Second" | "Megabits/Second" | "Gigabits/Second" | "Terabits/Second" | "Count/Second" | "None"

The unit to assign to the metric. If you omit this, the unit is set as None.

MetricFilterMetricTransformationUnit

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0