AWS SDK for C++  1.9.67
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudWatchLogs::Model::MetricTransformation Class Reference

#include <MetricTransformation.h>

Public Member Functions

 MetricTransformation ()
 
 MetricTransformation (Aws::Utils::Json::JsonView jsonValue)
 
MetricTransformationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const Aws::String &value)
 
void SetMetricName (Aws::String &&value)
 
void SetMetricName (const char *value)
 
MetricTransformationWithMetricName (const Aws::String &value)
 
MetricTransformationWithMetricName (Aws::String &&value)
 
MetricTransformationWithMetricName (const char *value)
 
const Aws::StringGetMetricNamespace () const
 
bool MetricNamespaceHasBeenSet () const
 
void SetMetricNamespace (const Aws::String &value)
 
void SetMetricNamespace (Aws::String &&value)
 
void SetMetricNamespace (const char *value)
 
MetricTransformationWithMetricNamespace (const Aws::String &value)
 
MetricTransformationWithMetricNamespace (Aws::String &&value)
 
MetricTransformationWithMetricNamespace (const char *value)
 
const Aws::StringGetMetricValue () const
 
bool MetricValueHasBeenSet () const
 
void SetMetricValue (const Aws::String &value)
 
void SetMetricValue (Aws::String &&value)
 
void SetMetricValue (const char *value)
 
MetricTransformationWithMetricValue (const Aws::String &value)
 
MetricTransformationWithMetricValue (Aws::String &&value)
 
MetricTransformationWithMetricValue (const char *value)
 
double GetDefaultValue () const
 
bool DefaultValueHasBeenSet () const
 
void SetDefaultValue (double value)
 
MetricTransformationWithDefaultValue (double value)
 
const Aws::Map< Aws::String, Aws::String > & GetDimensions () const
 
bool DimensionsHasBeenSet () const
 
void SetDimensions (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetDimensions (Aws::Map< Aws::String, Aws::String > &&value)
 
MetricTransformationWithDimensions (const Aws::Map< Aws::String, Aws::String > &value)
 
MetricTransformationWithDimensions (Aws::Map< Aws::String, Aws::String > &&value)
 
MetricTransformationAddDimensions (const Aws::String &key, const Aws::String &value)
 
MetricTransformationAddDimensions (Aws::String &&key, const Aws::String &value)
 
MetricTransformationAddDimensions (const Aws::String &key, Aws::String &&value)
 
MetricTransformationAddDimensions (Aws::String &&key, Aws::String &&value)
 
MetricTransformationAddDimensions (const char *key, Aws::String &&value)
 
MetricTransformationAddDimensions (Aws::String &&key, const char *value)
 
MetricTransformationAddDimensions (const char *key, const char *value)
 
const StandardUnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const StandardUnit &value)
 
void SetUnit (StandardUnit &&value)
 
MetricTransformationWithUnit (const StandardUnit &value)
 
MetricTransformationWithUnit (StandardUnit &&value)
 

Detailed Description

Indicates how to transform ingested log events to metric data in a CloudWatch metric.

See Also:

AWS API Reference

Definition at line 34 of file MetricTransformation.h.

Constructor & Destructor Documentation

◆ MetricTransformation() [1/2]

Aws::CloudWatchLogs::Model::MetricTransformation::MetricTransformation ( )

◆ MetricTransformation() [2/2]

Aws::CloudWatchLogs::Model::MetricTransformation::MetricTransformation ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddDimensions() [1/7]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::AddDimensions ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 393 of file MetricTransformation.h.

◆ AddDimensions() [2/7]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::AddDimensions ( Aws::String &&  key,
const Aws::String value 
)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 357 of file MetricTransformation.h.

◆ AddDimensions() [3/7]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::AddDimensions ( Aws::String &&  key,
const char *  value 
)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 429 of file MetricTransformation.h.

◆ AddDimensions() [4/7]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::AddDimensions ( const Aws::String key,
Aws::String &&  value 
)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 375 of file MetricTransformation.h.

◆ AddDimensions() [5/7]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::AddDimensions ( const Aws::String key,
const Aws::String value 
)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 339 of file MetricTransformation.h.

◆ AddDimensions() [6/7]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::AddDimensions ( const char *  key,
Aws::String &&  value 
)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 411 of file MetricTransformation.h.

◆ AddDimensions() [7/7]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::AddDimensions ( const char *  key,
const char *  value 
)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 447 of file MetricTransformation.h.

◆ DefaultValueHasBeenSet()

bool Aws::CloudWatchLogs::Model::MetricTransformation::DefaultValueHasBeenSet ( ) const
inline

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

Definition at line 200 of file MetricTransformation.h.

◆ DimensionsHasBeenSet()

bool Aws::CloudWatchLogs::Model::MetricTransformation::DimensionsHasBeenSet ( ) const
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 249 of file MetricTransformation.h.

◆ GetDefaultValue()

double Aws::CloudWatchLogs::Model::MetricTransformation::GetDefaultValue ( ) const
inline

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

Definition at line 194 of file MetricTransformation.h.

◆ GetDimensions()

const Aws::Map<Aws::String, Aws::String>& Aws::CloudWatchLogs::Model::MetricTransformation::GetDimensions ( ) const
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 231 of file MetricTransformation.h.

◆ GetMetricName()

const Aws::String& Aws::CloudWatchLogs::Model::MetricTransformation::GetMetricName ( ) const
inline

The name of the CloudWatch metric.

Definition at line 46 of file MetricTransformation.h.

◆ GetMetricNamespace()

const Aws::String& Aws::CloudWatchLogs::Model::MetricTransformation::GetMetricNamespace ( ) const
inline

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

Definition at line 89 of file MetricTransformation.h.

◆ GetMetricValue()

const Aws::String& Aws::CloudWatchLogs::Model::MetricTransformation::GetMetricValue ( ) const
inline

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

Definition at line 145 of file MetricTransformation.h.

◆ GetUnit()

const StandardUnit& Aws::CloudWatchLogs::Model::MetricTransformation::GetUnit ( ) const
inline

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

Definition at line 454 of file MetricTransformation.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CloudWatchLogs::Model::MetricTransformation::Jsonize ( ) const

◆ MetricNameHasBeenSet()

bool Aws::CloudWatchLogs::Model::MetricTransformation::MetricNameHasBeenSet ( ) const
inline

The name of the CloudWatch metric.

Definition at line 51 of file MetricTransformation.h.

◆ MetricNamespaceHasBeenSet()

bool Aws::CloudWatchLogs::Model::MetricTransformation::MetricNamespaceHasBeenSet ( ) const
inline

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

Definition at line 96 of file MetricTransformation.h.

◆ MetricValueHasBeenSet()

bool Aws::CloudWatchLogs::Model::MetricTransformation::MetricValueHasBeenSet ( ) const
inline

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

Definition at line 151 of file MetricTransformation.h.

◆ operator=()

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDefaultValue()

void Aws::CloudWatchLogs::Model::MetricTransformation::SetDefaultValue ( double  value)
inline

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

Definition at line 206 of file MetricTransformation.h.

◆ SetDimensions() [1/2]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetDimensions ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 285 of file MetricTransformation.h.

◆ SetDimensions() [2/2]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetDimensions ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 267 of file MetricTransformation.h.

◆ SetMetricName() [1/3]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetMetricName ( Aws::String &&  value)
inline

The name of the CloudWatch metric.

Definition at line 61 of file MetricTransformation.h.

◆ SetMetricName() [2/3]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetMetricName ( const Aws::String value)
inline

The name of the CloudWatch metric.

Definition at line 56 of file MetricTransformation.h.

◆ SetMetricName() [3/3]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetMetricName ( const char *  value)
inline

The name of the CloudWatch metric.

Definition at line 66 of file MetricTransformation.h.

◆ SetMetricNamespace() [1/3]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetMetricNamespace ( Aws::String &&  value)
inline

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

Definition at line 110 of file MetricTransformation.h.

◆ SetMetricNamespace() [2/3]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetMetricNamespace ( const Aws::String value)
inline

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

Definition at line 103 of file MetricTransformation.h.

◆ SetMetricNamespace() [3/3]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetMetricNamespace ( const char *  value)
inline

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

Definition at line 117 of file MetricTransformation.h.

◆ SetMetricValue() [1/3]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetMetricValue ( Aws::String &&  value)
inline

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

Definition at line 163 of file MetricTransformation.h.

◆ SetMetricValue() [2/3]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetMetricValue ( const Aws::String value)
inline

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

Definition at line 157 of file MetricTransformation.h.

◆ SetMetricValue() [3/3]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetMetricValue ( const char *  value)
inline

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

Definition at line 169 of file MetricTransformation.h.

◆ SetUnit() [1/2]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetUnit ( const StandardUnit value)
inline

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

Definition at line 466 of file MetricTransformation.h.

◆ SetUnit() [2/2]

void Aws::CloudWatchLogs::Model::MetricTransformation::SetUnit ( StandardUnit &&  value)
inline

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

Definition at line 472 of file MetricTransformation.h.

◆ UnitHasBeenSet()

bool Aws::CloudWatchLogs::Model::MetricTransformation::UnitHasBeenSet ( ) const
inline

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

Definition at line 460 of file MetricTransformation.h.

◆ WithDefaultValue()

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithDefaultValue ( double  value)
inline

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

Definition at line 212 of file MetricTransformation.h.

◆ WithDimensions() [1/2]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithDimensions ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 321 of file MetricTransformation.h.

◆ WithDimensions() [2/2]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithDimensions ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated AWS Charges.

Definition at line 303 of file MetricTransformation.h.

◆ WithMetricName() [1/3]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithMetricName ( Aws::String &&  value)
inline

The name of the CloudWatch metric.

Definition at line 76 of file MetricTransformation.h.

◆ WithMetricName() [2/3]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithMetricName ( const Aws::String value)
inline

The name of the CloudWatch metric.

Definition at line 71 of file MetricTransformation.h.

◆ WithMetricName() [3/3]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithMetricName ( const char *  value)
inline

The name of the CloudWatch metric.

Definition at line 81 of file MetricTransformation.h.

◆ WithMetricNamespace() [1/3]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithMetricNamespace ( Aws::String &&  value)
inline

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

Definition at line 131 of file MetricTransformation.h.

◆ WithMetricNamespace() [2/3]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithMetricNamespace ( const Aws::String value)
inline

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

Definition at line 124 of file MetricTransformation.h.

◆ WithMetricNamespace() [3/3]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithMetricNamespace ( const char *  value)
inline

A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

Definition at line 138 of file MetricTransformation.h.

◆ WithMetricValue() [1/3]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithMetricValue ( Aws::String &&  value)
inline

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

Definition at line 181 of file MetricTransformation.h.

◆ WithMetricValue() [2/3]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithMetricValue ( const Aws::String value)
inline

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

Definition at line 175 of file MetricTransformation.h.

◆ WithMetricValue() [3/3]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithMetricValue ( const char *  value)
inline

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

Definition at line 187 of file MetricTransformation.h.

◆ WithUnit() [1/2]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithUnit ( const StandardUnit value)
inline

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

Definition at line 478 of file MetricTransformation.h.

◆ WithUnit() [2/2]

MetricTransformation& Aws::CloudWatchLogs::Model::MetricTransformation::WithUnit ( StandardUnit &&  value)
inline

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

Definition at line 484 of file MetricTransformation.h.


The documentation for this class was generated from the following file: