software.amazon.awscdk.services.logs

Class CfnMetricFilter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.logs.CfnMetricFilter

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.699Z")
 @Stability(value=Stable)
public class CfnMetricFilter
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Logs::MetricFilter`.

The AWS::Logs::MetricFilter resource specifies a metric filter that describes how CloudWatch Logs extracts information from logs and transforms it into Amazon CloudWatch metrics. If you have multiple metric filters that are associated with a log group, all the filters are applied to the log streams in that group.

The maximum number of metric filters that can be associated with a log group is 100.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.logs.*;
 CfnMetricFilter cfnMetricFilter = CfnMetricFilter.Builder.create(this, "MyCfnMetricFilter")
         .filterPattern("filterPattern")
         .logGroupName("logGroupName")
         .metricTransformations(List.of(MetricTransformationProperty.builder()
                 .metricName("metricName")
                 .metricNamespace("metricNamespace")
                 .metricValue("metricValue")
                 // the properties below are optional
                 .defaultValue(123)
                 .dimensions(List.of(DimensionProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .unit("unit")
                 .build()))
         // the properties below are optional
         .filterName("filterName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMetricFilter.Builder A fluent builder for CfnMetricFilter.
static interface	CfnMetricFilter.DimensionProperty Example:
static interface	CfnMetricFilter.MetricTransformationProperty `MetricTransformation` is a property of the `AWS::Logs::MetricFilter` resource that describes how to transform log streams into a CloudWatch metric.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMetricFilter(software.constructs.Construct scope, String id, CfnMetricFilterProps props) Create a new `AWS::Logs::MetricFilter`.
protected	CfnMetricFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMetricFilter(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getFilterName() `AWS::Logs::MetricFilter.FilterName`.
String	getFilterPattern() A filter pattern for extracting metric data out of ingested log events.
String	getLogGroupName() The name of an existing log group that you want to associate with this metric filter.
Object	getMetricTransformations() The metric transformations.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFilterName(String value) `AWS::Logs::MetricFilter.FilterName`.
void	setFilterPattern(String value) A filter pattern for extracting metric data out of ingested log events.
void	setLogGroupName(String value) The name of an existing log group that you want to associate with this metric filter.
void	setMetricTransformations(IResolvable value) The metric transformations.
void	setMetricTransformations(List<Object> value) The metric transformations.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMetricFilter

protected CfnMetricFilter(software.amazon.jsii.JsiiObjectRef objRef)

CfnMetricFilter

protected CfnMetricFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMetricFilter

@Stability(value=Stable)
public CfnMetricFilter(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnMetricFilterProps props)

Create a new `AWS::Logs::MetricFilter`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFilterPattern

@Stability(value=Stable)
 @NotNull
public String getFilterPattern()

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

For more information, see Filter and Pattern Syntax .

setFilterPattern

@Stability(value=Stable)
public void setFilterPattern(@NotNull
                                                      String value)

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

For more information, see Filter and Pattern Syntax .

getLogGroupName

@Stability(value=Stable)
 @NotNull
public String getLogGroupName()

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

setLogGroupName

@Stability(value=Stable)
public void setLogGroupName(@NotNull
                                                     String value)

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

getMetricTransformations

@Stability(value=Stable)
 @NotNull
public Object getMetricTransformations()

The metric transformations.

setMetricTransformations

@Stability(value=Stable)
public void setMetricTransformations(@NotNull
                                                              IResolvable value)

The metric transformations.

setMetricTransformations

@Stability(value=Stable)
public void setMetricTransformations(@NotNull
                                                              List<Object> value)

The metric transformations.

getFilterName

@Stability(value=Stable)
 @Nullable
public String getFilterName()

`AWS::Logs::MetricFilter.FilterName`.

setFilterName

@Stability(value=Stable)
public void setFilterName(@Nullable
                                                   String value)

`AWS::Logs::MetricFilter.FilterName`.