Package software.amazon.awscdk.services.cloudwatch

Class MetricConfig.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.MetricConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MetricConfig>

Enclosing interface:

MetricConfig

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

A builder for MetricConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MetricConfig	build()	Builds the configured instance.
MetricConfig.Builder	mathExpression(MetricExpressionConfig mathExpression)	Sets the value of MetricConfig.getMathExpression()
MetricConfig.Builder	metricStat(MetricStatConfig metricStat)	Sets the value of MetricConfig.getMetricStat()
MetricConfig.Builder	renderingProperties(Map<String,? extends Object> renderingProperties)	Sets the value of MetricConfig.getRenderingProperties()
MetricConfig.Builder	searchExpression(MetricExpressionConfig searchExpression)	Sets the value of MetricConfig.getSearchExpression()

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

mathExpression

@Stability(Stable)
public MetricConfig.Builder mathExpression(MetricExpressionConfig mathExpression)

Sets the value of MetricConfig.getMathExpression()

Parameters:

mathExpression - In case the metric is a math expression, the details of the math expression.

Returns:

this

metricStat

@Stability(Stable)
public MetricConfig.Builder metricStat(MetricStatConfig metricStat)

Sets the value of MetricConfig.getMetricStat()

Parameters:

metricStat - In case the metric represents a query, the details of the query.

Returns:

this

renderingProperties

@Stability(Stable)
public MetricConfig.Builder renderingProperties(Map<String,? extends Object> renderingProperties)

Sets the value of MetricConfig.getRenderingProperties()

Parameters:

renderingProperties - Additional properties which will be rendered if the metric is used in a dashboard. Examples are 'label' and 'color', but any key in here will be added to dashboard graphs.

Returns:

this

searchExpression

@Stability(Stable)
public MetricConfig.Builder searchExpression(MetricExpressionConfig searchExpression)

Sets the value of MetricConfig.getSearchExpression()

Parameters:

searchExpression - In case the metric is a search expression, the details of the search expression.

Returns:

this

build

@Stability(Stable)
public MetricConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of MetricConfig

Throws:

NullPointerException - if any required attribute was not provided