Package software.amazon.awscdk.services.lightsail

Class CfnAlarm.Builder

java.lang.Object

software.amazon.awscdk.services.lightsail.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	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.
CfnAlarm.Builder	contactProtocols(List<String> contactProtocols)	The contact protocols for the alarm, such as Email , SMS (text messaging), or both.
static CfnAlarm.Builder	create(software.constructs.Construct scope, String id)
CfnAlarm.Builder	datapointsToAlarm(Number datapointsToAlarm)	The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM state.
CfnAlarm.Builder	evaluationPeriods(Number evaluationPeriods)	The number of periods over which data is compared to the specified threshold.
CfnAlarm.Builder	metricName(String metricName)	The name of the metric associated with the alarm.
CfnAlarm.Builder	monitoredResourceName(String monitoredResourceName)	The name of the Lightsail resource that the alarm monitors.
CfnAlarm.Builder	notificationEnabled(Boolean notificationEnabled)	A Boolean value indicating whether the alarm is enabled.
CfnAlarm.Builder	notificationEnabled(IResolvable notificationEnabled)	A Boolean value indicating whether the alarm is enabled.
CfnAlarm.Builder	notificationTriggers(List<String> notificationTriggers)	The alarm states that trigger a notification.
CfnAlarm.Builder	threshold(Number threshold)	The value against which the specified statistic is compared.
CfnAlarm.Builder	treatMissingData(String treatMissingData)	Specifies how the alarm handles missing data points.

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.

alarmName

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

The name of the alarm.

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-lightsail-alarm.html#cfn-lightsail-alarm-alarmname

comparisonOperator

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

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

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-lightsail-alarm.html#cfn-lightsail-alarm-comparisonoperator

evaluationPeriods

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

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

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-lightsail-alarm.html#cfn-lightsail-alarm-evaluationperiods

metricName

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

The name of the metric associated with the alarm.

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-lightsail-alarm.html#cfn-lightsail-alarm-metricname

monitoredResourceName

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

The name of the Lightsail resource that the alarm monitors.

Parameters:

monitoredResourceName - The name of the Lightsail resource that the alarm monitors. This parameter is required.

Returns:

this

See Also:

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

threshold

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

The value against which the specified statistic is compared.

Parameters:

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

Returns:

this

See Also:

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

contactProtocols

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

The contact protocols for the alarm, such as Email , SMS (text messaging), or both.

Allowed Values : Email | SMS

Parameters:

contactProtocols - The contact protocols for the alarm, such as Email , SMS (text messaging), or both. This parameter is required.

Returns:

this

See Also:

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

datapointsToAlarm

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

The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM state.

Parameters:

datapointsToAlarm - The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM state. This parameter is required.

Returns:

this

See Also:

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

notificationEnabled

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

A Boolean value indicating whether the alarm is enabled.

Parameters:

notificationEnabled - A Boolean value indicating whether the alarm is enabled. This parameter is required.

Returns:

this

See Also:

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

notificationEnabled

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

A Boolean value indicating whether the alarm is enabled.

Parameters:

notificationEnabled - A Boolean value indicating whether the alarm is enabled. This parameter is required.

Returns:

this

See Also:

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

notificationTriggers

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

The alarm states that trigger a notification.

To specify the OK and INSUFFICIENT_DATA values, you must also specify ContactProtocols values. Otherwise, the OK and INSUFFICIENT_DATA values will not take effect and the stack will drift.

Allowed Values : OK | ALARM | INSUFFICIENT_DATA

Parameters:

notificationTriggers - The alarm states that trigger a notification. This parameter is required.

Returns:

this

See Also:

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

treatMissingData

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

Specifies how the alarm handles missing data points.

An alarm can treat missing data in the following ways:

• breaching - Assumes the missing data is not within the threshold. Missing data counts towards the number of times that the metric is not within the threshold.
• notBreaching - Assumes the missing data is within the threshold. Missing data does not count towards the number of times that the metric is not within the threshold.
• ignore - Ignores the missing data. Maintains the current alarm state.
• missing - Missing data is treated as missing.

Parameters:

treatMissingData - Specifies how the alarm handles missing data points. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAlarm build()

Specified by:

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

Returns:

a newly built instance of CfnAlarm.