Package software.amazon.awscdk.services.cloudwatch

Class CfnAlarm.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CfnAlarm.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAlarm>

Enclosing class:

CfnAlarm

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

A fluent builder for CfnAlarm.

Method Summary

Modifier and Type	Method	Description
CfnAlarm.Builder	actionsEnabled(Boolean actionsEnabled)	Indicates whether actions should be executed during any changes to the alarm state.
CfnAlarm.Builder	actionsEnabled(IResolvable actionsEnabled)	Indicates whether actions should be executed during any changes to the alarm state.
CfnAlarm.Builder	alarmActions(List<String> alarmActions)	The list of actions to execute when this alarm transitions into an ALARM state from any other state.
CfnAlarm.Builder	alarmDescription(String alarmDescription)	The description of the alarm.
CfnAlarm.Builder	alarmName(String alarmName)	The name of the alarm.
CfnAlarm	build()
CfnAlarm.Builder	comparisonOperator(String comparisonOperator)	The arithmetic operation to use when comparing the specified statistic and threshold.
static CfnAlarm.Builder	create(software.constructs.Construct scope, String id)
CfnAlarm.Builder	datapointsToAlarm(Number datapointsToAlarm)	The number of datapoints that must be breaching to trigger the alarm.
CfnAlarm.Builder	dimensions(List<? extends Object> dimensions)	The dimensions for the metric associated with the alarm.
CfnAlarm.Builder	dimensions(IResolvable dimensions)	The dimensions for the metric associated with the alarm.
CfnAlarm.Builder	evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)	Used only for alarms based on percentiles.
CfnAlarm.Builder	evaluationPeriods(Number evaluationPeriods)	The number of periods over which data is compared to the specified threshold.
CfnAlarm.Builder	extendedStatistic(String extendedStatistic)	The percentile statistic for the metric associated with the alarm.
CfnAlarm.Builder	insufficientDataActions(List<String> insufficientDataActions)	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
CfnAlarm.Builder	metricName(String metricName)	The name of the metric associated with the alarm.
CfnAlarm.Builder	metrics(List<? extends Object> metrics)	An array that enables you to create an alarm based on the result of a metric math expression.
CfnAlarm.Builder	metrics(IResolvable metrics)	An array that enables you to create an alarm based on the result of a metric math expression.
CfnAlarm.Builder	namespace(String namespace)	The namespace of the metric associated with the alarm.
CfnAlarm.Builder	okActions(List<String> okActions)	The actions to execute when this alarm transitions to the OK state from any other state.
CfnAlarm.Builder	period(Number period)	The period, in seconds, over which the statistic is applied.
CfnAlarm.Builder	statistic(String statistic)	The statistic for the metric associated with the alarm, other than percentile.
CfnAlarm.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs to associate with the alarm.
CfnAlarm.Builder	threshold(Number threshold)	The value to compare with the specified statistic.
CfnAlarm.Builder	thresholdMetricId(String thresholdMetricId)	In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
CfnAlarm.Builder	treatMissingData(String treatMissingData)	Sets how this alarm is to handle missing data points.
CfnAlarm.Builder	unit(String unit)	The unit of the metric associated with the alarm.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnAlarm.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAlarm.Builder.

comparisonOperator

@Stability(Stable)
public CfnAlarm.Builder comparisonOperator(String comparisonOperator)

The arithmetic operation to use when comparing the specified statistic and threshold.

The specified statistic value is used as the first operand.

Parameters:

comparisonOperator - The arithmetic operation to use when comparing the specified statistic and threshold. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-comparisonoperator

evaluationPeriods

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

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

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.

For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-evaluationperiods

actionsEnabled

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

Indicates whether actions should be executed during any changes to the alarm state.

The default is TRUE.

Default: - true

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-actionsenabled

actionsEnabled

@Stability(Stable)
public CfnAlarm.Builder actionsEnabled(IResolvable actionsEnabled)

Indicates whether actions should be executed during any changes to the alarm state.

The default is TRUE.

Default: - true

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-actionsenabled

alarmActions

@Stability(Stable)
public CfnAlarm.Builder alarmActions(List<String> alarmActions)

The list of actions to execute when this alarm transitions into an ALARM state from any other state.

Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutMetricAlarm in the Amazon CloudWatch API Reference .

Parameters:

alarmActions - The list of actions to execute when this alarm transitions into an ALARM state from any other state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-alarmactions

alarmDescription

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

The description of the alarm.

Parameters:

alarmDescription - The description of the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-alarmdescription

alarmName

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

The name of the alarm.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

alarmName - The name of the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-alarmname

datapointsToAlarm

@Stability(Stable)
public CfnAlarm.Builder datapointsToAlarm(Number 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, and the value that you set for EvaluationPeriods is the N value. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .

If you omit this parameter, CloudWatch uses the same value here that you set for EvaluationPeriods , and the alarm goes to alarm state if that many consecutive periods are breaching.

Parameters:

datapointsToAlarm - The number of datapoints that must be breaching to trigger the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-datapointstoalarm

dimensions

@Stability(Stable)
public CfnAlarm.Builder dimensions(IResolvable dimensions)

The dimensions for the metric associated with the alarm.

For an alarm based on a math expression, you can't specify Dimensions . Instead, you use Metrics .

Parameters:

dimensions - The dimensions for the metric associated with the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-dimensions

dimensions

@Stability(Stable)
public CfnAlarm.Builder dimensions(List<? extends Object> dimensions)

The dimensions for the metric associated with the alarm.

For an alarm based on a math expression, you can't specify Dimensions . Instead, you use Metrics .

Parameters:

dimensions - The dimensions for the metric associated with the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-dimensions

evaluateLowSampleCountPercentile

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

Used only for alarms based on percentiles.

If ignore , the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

Parameters:

evaluateLowSampleCountPercentile - Used only for alarms based on percentiles. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-evaluatelowsamplecountpercentile

extendedStatistic

@Stability(Stable)
public CfnAlarm.Builder extendedStatistic(String extendedStatistic)

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

For an alarm based on a math expression, you can't specify ExtendedStatistic . Instead, you use Metrics .

Parameters:

extendedStatistic - The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-extendedstatistic

insufficientDataActions

@Stability(Stable)
public CfnAlarm.Builder insufficientDataActions(List<String> insufficientDataActions)

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.

Each action is specified as an Amazon Resource Name (ARN).

Parameters:

insufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-insufficientdataactions

metricName

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

The name of the metric associated with the alarm.

This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName .

Parameters:

metricName - The name of the metric associated with the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-metricname

metrics

@Stability(Stable)
public CfnAlarm.Builder metrics(IResolvable metrics)

An array that enables you to create an alarm based on the result of a metric math expression.

Each item in the array either retrieves a metric or performs a math expression.

If you specify the Metrics parameter, you cannot specify MetricName , Dimensions , Period , Namespace , Statistic , ExtendedStatistic , or Unit .

Parameters:

metrics - An array that enables you to create an alarm based on the result of a metric math expression. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-metrics

metrics

@Stability(Stable)
public CfnAlarm.Builder metrics(List<? extends Object> metrics)

An array that enables you to create an alarm based on the result of a metric math expression.

Each item in the array either retrieves a metric or performs a math expression.

If you specify the Metrics parameter, you cannot specify MetricName , Dimensions , Period , Namespace , Statistic , ExtendedStatistic , or Unit .

Parameters:

metrics - An array that enables you to create an alarm based on the result of a metric math expression. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-metrics

namespace

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

The namespace of the metric associated with the alarm.

This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

For a list of namespaces for metrics from AWS services, see AWS Services That Publish CloudWatch Metrics.

Parameters:

namespace - The namespace of the metric associated with the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-namespace

okActions

@Stability(Stable)
public CfnAlarm.Builder okActions(List<String> okActions)

The actions to execute when this alarm transitions to the OK state from any other state.

Each action is specified as an Amazon Resource Name (ARN).

Parameters:

okActions - The actions to execute when this alarm transitions to the OK state from any other state. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-okactions

period

@Stability(Stable)
public CfnAlarm.Builder period(Number period)

The period, in seconds, over which the statistic is applied.

This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.

For an alarm based on a math expression, you can't specify Period , and instead you use the Metrics parameter.

Minimum: 10

Parameters:

period - The period, in seconds, over which the statistic is applied. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-period

statistic

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

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic .

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

For an alarm based on a math expression, you can't specify Statistic . Instead, you use Metrics .

Parameters:

statistic - The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-statistic

tags

@Stability(Stable)
public CfnAlarm.Builder tags(List<? extends CfnTag> tags)

A list of key-value pairs to associate with the alarm.

You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Parameters:

tags - A list of key-value pairs to associate with the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-tags

threshold

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

The value to compare with the specified statistic.

Parameters:

threshold - The value to compare with the specified statistic. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-threshold

thresholdMetricId

@Stability(Stable)
public CfnAlarm.Builder thresholdMetricId(String thresholdMetricId)

In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

Parameters:

thresholdMetricId - In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-thresholdmetricid

treatMissingData

@Stability(Stable)
public CfnAlarm.Builder treatMissingData(String treatMissingData)

Sets how this alarm is to handle missing data points.

Valid values are breaching , notBreaching , ignore , and missing . For more information, see Configuring How CloudWatch Alarms Treat Missing Data in the Amazon CloudWatch User Guide .

If you omit this parameter, the default behavior of missing is used.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-treatmissingdata

unit

@Stability(Stable)
public CfnAlarm.Builder unit(String unit)

The unit of the metric associated with the alarm.

Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.

You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.

Parameters:

unit - The unit of the metric associated with the alarm. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#cfn-cloudwatch-alarm-unit

build

@Stability(Stable)
public CfnAlarm build()

Specified by:

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

Returns:

a newly built instance of CfnAlarm.