Package software.amazon.awscdk.services.cloudwatch

Class CreateAlarmOptions.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CreateAlarmOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CreateAlarmOptions>

Enclosing interface:

CreateAlarmOptions

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

A builder for CreateAlarmOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateAlarmOptions.Builder	actionsEnabled(Boolean actionsEnabled)	Sets the value of CreateAlarmOptions.getActionsEnabled()
CreateAlarmOptions.Builder	alarmDescription(String alarmDescription)	Sets the value of CreateAlarmOptions.getAlarmDescription()
CreateAlarmOptions.Builder	alarmName(String alarmName)	Sets the value of CreateAlarmOptions.getAlarmName()
CreateAlarmOptions	build()	Builds the configured instance.
CreateAlarmOptions.Builder	comparisonOperator(ComparisonOperator comparisonOperator)	Sets the value of CreateAlarmOptions.getComparisonOperator()
CreateAlarmOptions.Builder	datapointsToAlarm(Number datapointsToAlarm)	Sets the value of CreateAlarmOptions.getDatapointsToAlarm()
CreateAlarmOptions.Builder	evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)	Sets the value of CreateAlarmOptions.getEvaluateLowSampleCountPercentile()
CreateAlarmOptions.Builder	evaluationPeriods(Number evaluationPeriods)	Sets the value of CreateAlarmOptions.getEvaluationPeriods()
CreateAlarmOptions.Builder	period(Duration period)	Deprecated. Use `metric.with({ period: ...
CreateAlarmOptions.Builder	statistic(String statistic)	Deprecated. Use `metric.with({ statistic: ...
CreateAlarmOptions.Builder	threshold(Number threshold)	Sets the value of CreateAlarmOptions.getThreshold()
CreateAlarmOptions.Builder	treatMissingData(TreatMissingData treatMissingData)	Sets the value of CreateAlarmOptions.getTreatMissingData()

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

evaluationPeriods

@Stability(Stable)
public CreateAlarmOptions.Builder evaluationPeriods(Number evaluationPeriods)

Sets the value of CreateAlarmOptions.getEvaluationPeriods()

Parameters:

evaluationPeriods - The number of periods over which data is compared to the specified threshold. This parameter is required.

Returns:

this

threshold

@Stability(Stable)
public CreateAlarmOptions.Builder threshold(Number threshold)

Sets the value of CreateAlarmOptions.getThreshold()

Parameters:

threshold - The value against which the specified statistic is compared. This parameter is required.

Returns:

this

actionsEnabled

@Stability(Stable)
public CreateAlarmOptions.Builder actionsEnabled(Boolean actionsEnabled)

Sets the value of CreateAlarmOptions.getActionsEnabled()

Parameters:

actionsEnabled - Whether the actions for this alarm are enabled.

Returns:

this

alarmDescription

@Stability(Stable)
public CreateAlarmOptions.Builder alarmDescription(String alarmDescription)

Sets the value of CreateAlarmOptions.getAlarmDescription()

Parameters:

alarmDescription - Description for the alarm.

Returns:

this

alarmName

@Stability(Stable)
public CreateAlarmOptions.Builder alarmName(String alarmName)

Sets the value of CreateAlarmOptions.getAlarmName()

Parameters:

alarmName - Name of the alarm.

Returns:

this

comparisonOperator

@Stability(Stable)
public CreateAlarmOptions.Builder comparisonOperator(ComparisonOperator comparisonOperator)

Sets the value of CreateAlarmOptions.getComparisonOperator()

Parameters:

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

Returns:

this

datapointsToAlarm

@Stability(Stable)
public CreateAlarmOptions.Builder datapointsToAlarm(Number datapointsToAlarm)

Sets the value of CreateAlarmOptions.getDatapointsToAlarm()

Parameters:

datapointsToAlarm - The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

Returns:

this

evaluateLowSampleCountPercentile

@Stability(Stable)
public CreateAlarmOptions.Builder evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)

Sets the value of CreateAlarmOptions.getEvaluateLowSampleCountPercentile()

Parameters:

evaluateLowSampleCountPercentile - Specifies whether to evaluate the data and potentially change the alarm state if there are too few data points to be statistically significant. Used only for alarms that are based on percentiles.

Returns:

this

period

@Stability(Deprecated)
@Deprecated
public CreateAlarmOptions.Builder period(Duration period)

Deprecated.

Use `metric.with({ period: ... })` to encode the period into the Metric object

Sets the value of CreateAlarmOptions.getPeriod()

Parameters:

period - The period over which the specified statistic is applied. Cannot be used with MathExpression objects.

Returns:

this

statistic

@Stability(Deprecated)
@Deprecated
public CreateAlarmOptions.Builder statistic(String statistic)

Deprecated.

Use `metric.with({ statistic: ... })` to encode the period into the Metric object

Sets the value of CreateAlarmOptions.getStatistic()

Parameters:

statistic - What function to use for aggregating. Can be one of the following:

• "Minimum" | "min"
• "Maximum" | "max"
• "Average" | "avg"
• "Sum" | "sum"
• "SampleCount | "n"
• "pNN.NN"

Cannot be used with MathExpression objects.

Returns:

this

treatMissingData

@Stability(Stable)
public CreateAlarmOptions.Builder treatMissingData(TreatMissingData treatMissingData)

Sets the value of CreateAlarmOptions.getTreatMissingData()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CreateAlarmOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CreateAlarmOptions

Throws:

NullPointerException - if any required attribute was not provided