Package software.amazon.awscdk.services.logs

Class MetricFilterOptions.Builder

java.lang.Object

software.amazon.awscdk.services.logs.MetricFilterOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MetricFilterOptions>

Enclosing interface:

MetricFilterOptions

@Stability(Stable)
public static final class MetricFilterOptions.Builder
extends Object
implements software.amazon.jsii.Builder<MetricFilterOptions>

A builder for MetricFilterOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MetricFilterOptions	build()	Builds the configured instance.
MetricFilterOptions.Builder	defaultValue(Number defaultValue)	Sets the value of MetricFilterOptions.getDefaultValue()
MetricFilterOptions.Builder	dimensions(Map<String,String> dimensions)	Sets the value of MetricFilterOptions.getDimensions()
MetricFilterOptions.Builder	filterName(String filterName)	Sets the value of MetricFilterOptions.getFilterName()
MetricFilterOptions.Builder	filterPattern(IFilterPattern filterPattern)	Sets the value of MetricFilterOptions.getFilterPattern()
MetricFilterOptions.Builder	metricName(String metricName)	Sets the value of MetricFilterOptions.getMetricName()
MetricFilterOptions.Builder	metricNamespace(String metricNamespace)	Sets the value of MetricFilterOptions.getMetricNamespace()
MetricFilterOptions.Builder	metricValue(String metricValue)	Sets the value of MetricFilterOptions.getMetricValue()
MetricFilterOptions.Builder	unit(Unit unit)	Sets the value of MetricFilterOptions.getUnit()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

filterPattern

@Stability(Stable)
public MetricFilterOptions.Builder filterPattern(IFilterPattern filterPattern)

Sets the value of MetricFilterOptions.getFilterPattern()

Parameters:

filterPattern - Pattern to search for log events. This parameter is required.

Returns:

this

metricName

@Stability(Stable)
public MetricFilterOptions.Builder metricName(String metricName)

Sets the value of MetricFilterOptions.getMetricName()

Parameters:

metricName - The name of the metric to emit. This parameter is required.

Returns:

this

metricNamespace

@Stability(Stable)
public MetricFilterOptions.Builder metricNamespace(String metricNamespace)

Sets the value of MetricFilterOptions.getMetricNamespace()

Parameters:

metricNamespace - The namespace of the metric to emit. This parameter is required.

Returns:

this

defaultValue

@Stability(Stable)
public MetricFilterOptions.Builder defaultValue(Number defaultValue)

Sets the value of MetricFilterOptions.getDefaultValue()

Parameters:

defaultValue - The value to emit if the pattern does not match a particular event.

Returns:

this

dimensions

@Stability(Stable)
public MetricFilterOptions.Builder dimensions(Map<String,String> dimensions)

Sets the value of MetricFilterOptions.getDimensions()

Parameters:

dimensions - The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.

Returns:

this

filterName

@Stability(Stable)
public MetricFilterOptions.Builder filterName(String filterName)

Sets the value of MetricFilterOptions.getFilterName()

Parameters:

filterName - The name of the metric filter.

Returns:

this

metricValue

@Stability(Stable)
public MetricFilterOptions.Builder metricValue(String metricValue)

Sets the value of MetricFilterOptions.getMetricValue()

Parameters:

metricValue - The value to emit for the metric. Can either be a literal number (typically "1"), or the name of a field in the structure to take the value from the matched event. If you are using a field value, the field value must have been matched using the pattern.

If you want to specify a field from a matched JSON structure, use '$.fieldName', and make sure the field is in the pattern (if only as '$.fieldName = *').

If you want to specify a field from a matched space-delimited structure, use '$fieldName'.

Returns:

this

unit

@Stability(Stable)
public MetricFilterOptions.Builder unit(Unit unit)

Sets the value of MetricFilterOptions.getUnit()

Parameters:

unit - The unit to assign to the metric.

Returns:

this

build

@Stability(Stable)
public MetricFilterOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<MetricFilterOptions>

Returns:

a new instance of MetricFilterOptions

Throws:

NullPointerException - if any required attribute was not provided