Package software.amazon.awscdk.cfnpropertymixins.services.lightsail

Class CfnAlarmMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.lightsail.CfnAlarmMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAlarmMixinProps>

Enclosing interface:

CfnAlarmMixinProps

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

A builder for CfnAlarmMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

alarmName

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

Sets the value of CfnAlarmMixinProps.getAlarmName()

Parameters:

alarmName - The name of the alarm.

Returns:

this

comparisonOperator

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

Sets the value of CfnAlarmMixinProps.getComparisonOperator()

Parameters:

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

Returns:

this

contactProtocols

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

Sets the value of CfnAlarmMixinProps.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(Stable)
public CfnAlarmMixinProps.Builder datapointsToAlarm(Number datapointsToAlarm)

Sets the value of CfnAlarmMixinProps.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

evaluationPeriods

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

Sets the value of CfnAlarmMixinProps.getEvaluationPeriods()

Parameters:

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

Returns:

this

metricName

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

Sets the value of CfnAlarmMixinProps.getMetricName()

Parameters:

metricName - The name of the metric associated with the alarm.

Returns:

this

monitoredResourceName

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

Sets the value of CfnAlarmMixinProps.getMonitoredResourceName()

Parameters:

monitoredResourceName - The name of the Lightsail resource that the alarm monitors.

Returns:

this

notificationEnabled

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

Sets the value of CfnAlarmMixinProps.getNotificationEnabled()

Parameters:

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

Returns:

this

notificationEnabled

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

Sets the value of CfnAlarmMixinProps.getNotificationEnabled()

Parameters:

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

Returns:

this

notificationTriggers

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

Sets the value of CfnAlarmMixinProps.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

threshold

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

Sets the value of CfnAlarmMixinProps.getThreshold()

Parameters:

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

Returns:

this

treatMissingData

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

Sets the value of CfnAlarmMixinProps.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(Stable)
public CfnAlarmMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAlarmMixinProps

Throws:

NullPointerException - if any required attribute was not provided