software.amazon.awscdk.services.lightsail

Class CfnAlarmProps.Builder

java.lang.Object

software.amazon.awscdk.services.lightsail.CfnAlarmProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAlarmProps>

Enclosing interface:

CfnAlarmProps

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

A builder for CfnAlarmProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnAlarmProps.Builder	alarmName(String alarmName) Sets the value of CfnAlarmProps.getAlarmName()
CfnAlarmProps	build() Builds the configured instance.
CfnAlarmProps.Builder	comparisonOperator(String comparisonOperator) Sets the value of CfnAlarmProps.getComparisonOperator()
CfnAlarmProps.Builder	contactProtocols(List<String> contactProtocols) Sets the value of CfnAlarmProps.getContactProtocols()
CfnAlarmProps.Builder	datapointsToAlarm(Number datapointsToAlarm) Sets the value of CfnAlarmProps.getDatapointsToAlarm()
CfnAlarmProps.Builder	evaluationPeriods(Number evaluationPeriods) Sets the value of CfnAlarmProps.getEvaluationPeriods()
CfnAlarmProps.Builder	metricName(String metricName) Sets the value of CfnAlarmProps.getMetricName()
CfnAlarmProps.Builder	monitoredResourceName(String monitoredResourceName) Sets the value of CfnAlarmProps.getMonitoredResourceName()
CfnAlarmProps.Builder	notificationEnabled(Boolean notificationEnabled) Sets the value of CfnAlarmProps.getNotificationEnabled()
CfnAlarmProps.Builder	notificationEnabled(IResolvable notificationEnabled) Sets the value of CfnAlarmProps.getNotificationEnabled()
CfnAlarmProps.Builder	notificationTriggers(List<String> notificationTriggers) Sets the value of CfnAlarmProps.getNotificationTriggers()
CfnAlarmProps.Builder	threshold(Number threshold) Sets the value of CfnAlarmProps.getThreshold()
CfnAlarmProps.Builder	treatMissingData(String treatMissingData) Sets the value of CfnAlarmProps.getTreatMissingData()

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

alarmName

@Stability(value=Stable)
public CfnAlarmProps.Builder alarmName(String alarmName)

Sets the value of CfnAlarmProps.getAlarmName()

Parameters:

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

Returns:

this

comparisonOperator

@Stability(value=Stable)
public CfnAlarmProps.Builder comparisonOperator(String comparisonOperator)

Sets the value of CfnAlarmProps.getComparisonOperator()

Parameters:

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

Returns:

this

evaluationPeriods

@Stability(value=Stable)
public CfnAlarmProps.Builder evaluationPeriods(Number evaluationPeriods)

Sets the value of CfnAlarmProps.getEvaluationPeriods()

Parameters:

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

Returns:

this

metricName

@Stability(value=Stable)
public CfnAlarmProps.Builder metricName(String metricName)

Sets the value of CfnAlarmProps.getMetricName()

Parameters:

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

Returns:

this

monitoredResourceName

@Stability(value=Stable)
public CfnAlarmProps.Builder monitoredResourceName(String monitoredResourceName)

Sets the value of CfnAlarmProps.getMonitoredResourceName()

Parameters:

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

Returns:

this

threshold

@Stability(value=Stable)
public CfnAlarmProps.Builder threshold(Number threshold)

Sets the value of CfnAlarmProps.getThreshold()

Parameters:

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

Returns:

this

contactProtocols

@Stability(value=Stable)
public CfnAlarmProps.Builder contactProtocols(List<String> contactProtocols)

Sets the value of CfnAlarmProps.getContactProtocols()

Parameters:

contactProtocols - The contact protocols for the alarm, such as `Email` , `SMS` (text messaging), or both. Allowed Values : Email | SMS

Returns:

this

datapointsToAlarm

@Stability(value=Stable)
public CfnAlarmProps.Builder datapointsToAlarm(Number datapointsToAlarm)

Sets the value of CfnAlarmProps.getDatapointsToAlarm()

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.

Returns:

this

notificationEnabled

@Stability(value=Stable)
public CfnAlarmProps.Builder notificationEnabled(Boolean notificationEnabled)

Sets the value of CfnAlarmProps.getNotificationEnabled()

Parameters:

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

Returns:

this

notificationEnabled

@Stability(value=Stable)
public CfnAlarmProps.Builder notificationEnabled(IResolvable notificationEnabled)

Sets the value of CfnAlarmProps.getNotificationEnabled()

Parameters:

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

Returns:

this

notificationTriggers

@Stability(value=Stable)
public CfnAlarmProps.Builder notificationTriggers(List<String> notificationTriggers)

Sets the value of CfnAlarmProps.getNotificationTriggers()

Parameters:

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

Returns:

this

treatMissingData

@Stability(value=Stable)
public CfnAlarmProps.Builder treatMissingData(String treatMissingData)

Sets the value of CfnAlarmProps.getTreatMissingData()

Parameters:

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.

Returns:

this

build

@Stability(value=Stable)
public CfnAlarmProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAlarmProps

Throws:

NullPointerException - if any required attribute was not provided