software.amazon.awscdk.services.cloudwatch

Class AlarmProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.AlarmProps.Builder

Enclosing interface:

AlarmProps

@Stability(value=Experimental)
public static final class AlarmProps.Builder
extends Object

A builder for AlarmProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AlarmProps	build() Builds the configured instance.
AlarmProps.Builder	withActionsEnabled(Boolean value) Sets the value of ActionsEnabled
AlarmProps.Builder	withAlarmDescription(String value) Sets the value of AlarmDescription
AlarmProps.Builder	withAlarmName(String value) Sets the value of AlarmName
AlarmProps.Builder	withComparisonOperator(ComparisonOperator value) Sets the value of ComparisonOperator
AlarmProps.Builder	withDatapointsToAlarm(Number value) Sets the value of DatapointsToAlarm
AlarmProps.Builder	withEvaluateLowSampleCountPercentile(String value) Sets the value of EvaluateLowSampleCountPercentile
AlarmProps.Builder	withEvaluationPeriods(Number value) Sets the value of EvaluationPeriods
AlarmProps.Builder	withMetric(IMetric value) Sets the value of Metric
AlarmProps.Builder	withPeriod(software.amazon.awscdk.core.Duration value) Sets the value of Period
AlarmProps.Builder	withStatistic(String value) Sets the value of Statistic
AlarmProps.Builder	withThreshold(Number value) Sets the value of Threshold
AlarmProps.Builder	withTreatMissingData(TreatMissingData value) Sets the value of TreatMissingData

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withMetric

@Stability(value=Experimental)
public AlarmProps.Builder withMetric(IMetric value)

Sets the value of Metric

Parameters:

value - The metric to add the alarm on.

Returns:

this

withEvaluationPeriods

@Stability(value=Experimental)
public AlarmProps.Builder withEvaluationPeriods(Number value)

Sets the value of EvaluationPeriods

Parameters:

value - The number of periods over which data is compared to the specified threshold.

Returns:

this

withThreshold

@Stability(value=Experimental)
public AlarmProps.Builder withThreshold(Number value)

Sets the value of Threshold

Parameters:

value - The value against which the specified statistic is compared.

Returns:

this

withActionsEnabled

@Stability(value=Experimental)
public AlarmProps.Builder withActionsEnabled(@Nullable
                                                                            Boolean value)

Sets the value of ActionsEnabled

Parameters:

value - Whether the actions for this alarm are enabled.

Returns:

this

withAlarmDescription

@Stability(value=Experimental)
public AlarmProps.Builder withAlarmDescription(@Nullable
                                                                              String value)

Sets the value of AlarmDescription

Parameters:

value - Description for the alarm.

Returns:

this

withAlarmName

@Stability(value=Experimental)
public AlarmProps.Builder withAlarmName(@Nullable
                                                                       String value)

Sets the value of AlarmName

Parameters:

value - Name of the alarm.

Returns:

this

withComparisonOperator

@Stability(value=Experimental)
public AlarmProps.Builder withComparisonOperator(@Nullable
                                                                                ComparisonOperator value)

Sets the value of ComparisonOperator

Parameters:

value - Comparison to use to check if metric is breaching.

Returns:

this

withDatapointsToAlarm

@Stability(value=Experimental)
public AlarmProps.Builder withDatapointsToAlarm(@Nullable
                                                                               Number value)

Sets the value of DatapointsToAlarm

Parameters:

value - The number of datapoints that must be breaching to trigger the alarm.

Returns:

this

withEvaluateLowSampleCountPercentile

@Stability(value=Experimental)
public AlarmProps.Builder withEvaluateLowSampleCountPercentile(@Nullable
                                                                                              String value)

Sets the value of EvaluateLowSampleCountPercentile

Parameters:

value - Specifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant.

Returns:

this

withPeriod

@Stability(value=Experimental)
public AlarmProps.Builder withPeriod(@Nullable
                                                                    software.amazon.awscdk.core.Duration value)

Sets the value of Period

Parameters:

value - The period over which the specified statistic is applied.

Returns:

this

withStatistic

@Stability(value=Experimental)
public AlarmProps.Builder withStatistic(@Nullable
                                                                       String value)

Sets the value of Statistic

Parameters:

value - What function to use for aggregating.

Returns:

this

withTreatMissingData

@Stability(value=Experimental)
public AlarmProps.Builder withTreatMissingData(@Nullable
                                                                              TreatMissingData value)

Sets the value of TreatMissingData

Parameters:

value - Sets how this alarm is to handle missing data points.

Returns:

this

build

@Stability(value=Experimental)
public AlarmProps build()

Builds the configured instance.

Returns:

a new instance of AlarmProps

Throws:

NullPointerException - if any required attribute was not provided