Package software.amazon.awscdk.services.cloudwatch

Class MetricStatConfig.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.MetricStatConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MetricStatConfig>

Enclosing interface:

MetricStatConfig

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

A builder for MetricStatConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MetricStatConfig.Builder	account(String account)	Sets the value of MetricStatConfig.getAccount()
MetricStatConfig.Builder	accountOverride(String accountOverride)	Sets the value of MetricStatConfig.getAccountOverride()
MetricStatConfig	build()	Builds the configured instance.
MetricStatConfig.Builder	dimensions(List<? extends Dimension> dimensions)	Sets the value of MetricStatConfig.getDimensions()
MetricStatConfig.Builder	metricName(String metricName)	Sets the value of MetricStatConfig.getMetricName()
MetricStatConfig.Builder	namespace(String namespace)	Sets the value of MetricStatConfig.getNamespace()
MetricStatConfig.Builder	period(Duration period)	Sets the value of MetricStatConfig.getPeriod()
MetricStatConfig.Builder	region(String region)	Sets the value of MetricStatConfig.getRegion()
MetricStatConfig.Builder	regionOverride(String regionOverride)	Sets the value of MetricStatConfig.getRegionOverride()
MetricStatConfig.Builder	statistic(String statistic)	Sets the value of MetricStatConfig.getStatistic()
MetricStatConfig.Builder	unitFilter(Unit unitFilter)	Sets the value of MetricStatConfig.getUnitFilter()

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

metricName

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

Sets the value of MetricStatConfig.getMetricName()

Parameters:

metricName - Name of the metric. This parameter is required.

Returns:

this

namespace

@Stability(Stable)
public MetricStatConfig.Builder namespace(String namespace)

Sets the value of MetricStatConfig.getNamespace()

Parameters:

namespace - Namespace of the metric. This parameter is required.

Returns:

this

period

@Stability(Stable)
public MetricStatConfig.Builder period(Duration period)

Sets the value of MetricStatConfig.getPeriod()

Parameters:

period - How many seconds to aggregate over. This parameter is required.

Returns:

this

statistic

@Stability(Stable)
public MetricStatConfig.Builder statistic(String statistic)

Sets the value of MetricStatConfig.getStatistic()

Parameters:

statistic - Aggregation function to use (can be either simple or a percentile). This parameter is required.

Returns:

this

account

@Stability(Stable)
public MetricStatConfig.Builder account(String account)

Sets the value of MetricStatConfig.getAccount()

Parameters:

account - Account which this metric comes from.

Returns:

this

accountOverride

@Stability(Stable)
public MetricStatConfig.Builder accountOverride(String accountOverride)

Sets the value of MetricStatConfig.getAccountOverride()

Parameters:

accountOverride - Account set directly on the metric, not inherited from the attached stack.

Returns:

this

dimensions

@Stability(Stable)
public MetricStatConfig.Builder dimensions(List<? extends Dimension> dimensions)

Sets the value of MetricStatConfig.getDimensions()

Parameters:

dimensions - The dimensions to apply to the alarm.

Returns:

this

region

@Stability(Stable)
public MetricStatConfig.Builder region(String region)

Sets the value of MetricStatConfig.getRegion()

Parameters:

region - Region which this metric comes from.

Returns:

this

regionOverride

@Stability(Stable)
public MetricStatConfig.Builder regionOverride(String regionOverride)

Sets the value of MetricStatConfig.getRegionOverride()

Parameters:

regionOverride - Region set directly on the metric, not inherited from the attached stack.

Returns:

this

unitFilter

@Stability(Stable)
public MetricStatConfig.Builder unitFilter(Unit unitFilter)

Sets the value of MetricStatConfig.getUnitFilter()

Parameters:

unitFilter - Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units.

This field has been renamed from plain unit to clearly communicate its purpose.

Returns:

this

build

@Stability(Stable)
public MetricStatConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of MetricStatConfig

Throws:

NullPointerException - if any required attribute was not provided