Package software.amazon.awscdk.services.logs

Class CfnMetricFilter.Builder

java.lang.Object

software.amazon.awscdk.services.logs.CfnMetricFilter.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMetricFilter>

Enclosing class:

CfnMetricFilter

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

A fluent builder for CfnMetricFilter.

Method Summary

Modifier and Type	Method	Description
CfnMetricFilter.Builder	applyOnTransformedLogs(Boolean applyOnTransformedLogs)	This parameter is valid only for log groups that have an active log transformer.
CfnMetricFilter.Builder	applyOnTransformedLogs(IResolvable applyOnTransformedLogs)	This parameter is valid only for log groups that have an active log transformer.
CfnMetricFilter	build()
static CfnMetricFilter.Builder	create(software.constructs.Construct scope, String id)
CfnMetricFilter.Builder	filterName(String filterName)	The name of the metric filter.
CfnMetricFilter.Builder	filterPattern(String filterPattern)	A filter pattern for extracting metric data out of ingested log events.
CfnMetricFilter.Builder	logGroupName(String logGroupName)	The name of an existing log group that you want to associate with this metric filter.
CfnMetricFilter.Builder	metricTransformations(List<? extends Object> metricTransformations)	The metric transformations.
CfnMetricFilter.Builder	metricTransformations(IResolvable metricTransformations)	The metric transformations.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnMetricFilter.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnMetricFilter.Builder.

filterPattern

@Stability(Stable)
public CfnMetricFilter.Builder filterPattern(String filterPattern)

A filter pattern for extracting metric data out of ingested log events.

For more information, see Filter and Pattern Syntax .

Parameters:

filterPattern - A filter pattern for extracting metric data out of ingested log events. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filterpattern

logGroupName

@Stability(Stable)
public CfnMetricFilter.Builder logGroupName(String logGroupName)

The name of an existing log group that you want to associate with this metric filter.

Parameters:

logGroupName - The name of an existing log group that you want to associate with this metric filter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-loggroupname

metricTransformations

@Stability(Stable)
public CfnMetricFilter.Builder metricTransformations(IResolvable metricTransformations)

The metric transformations.

Parameters:

metricTransformations - The metric transformations. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-metrictransformations

metricTransformations

@Stability(Stable)
public CfnMetricFilter.Builder metricTransformations(List<? extends Object> metricTransformations)

The metric transformations.

Parameters:

metricTransformations - The metric transformations. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-metrictransformations

applyOnTransformedLogs

@Stability(Stable)
public CfnMetricFilter.Builder applyOnTransformedLogs(Boolean applyOnTransformedLogs)

This parameter is valid only for log groups that have an active log transformer.

For more information about log transformers, see PutTransformer .

If this value is true , the metric filter is applied on the transformed version of the log events instead of the original ingested log events.

Parameters:

applyOnTransformedLogs - This parameter is valid only for log groups that have an active log transformer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-applyontransformedlogs

applyOnTransformedLogs

@Stability(Stable)
public CfnMetricFilter.Builder applyOnTransformedLogs(IResolvable applyOnTransformedLogs)

This parameter is valid only for log groups that have an active log transformer.

For more information about log transformers, see PutTransformer .

If this value is true , the metric filter is applied on the transformed version of the log events instead of the original ingested log events.

Parameters:

applyOnTransformedLogs - This parameter is valid only for log groups that have an active log transformer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-applyontransformedlogs

filterName

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

The name of the metric filter.

Parameters:

filterName - The name of the metric filter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filtername

build

@Stability(Stable)
public CfnMetricFilter build()

Specified by:

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

Returns:

a newly built instance of CfnMetricFilter.