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

Class CfnAlarmMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.lightsail.CfnAlarmMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnAlarmMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAlarmMixinProps

@Stability(Stable)
@Internal
public static final class CfnAlarmMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnAlarmMixinProps

An implementation for CfnAlarmMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.lightsail.CfnAlarmMixinProps

CfnAlarmMixinProps.Builder, CfnAlarmMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAlarmMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAlarmMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAlarmName()	The name of the alarm.
final String	getComparisonOperator()	The arithmetic operation to use when comparing the specified statistic and threshold.
final List<String>	getContactProtocols()	The contact protocols for the alarm, such as Email , SMS (text messaging), or both.
final Number	getDatapointsToAlarm()	The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM state.
final Number	getEvaluationPeriods()	The number of periods over which data is compared to the specified threshold.
final String	getMetricName()	The name of the metric associated with the alarm.
final String	getMonitoredResourceName()	The name of the Lightsail resource that the alarm monitors.
final Object	getNotificationEnabled()	A Boolean value indicating whether the alarm is enabled.
final List<String>	getNotificationTriggers()	The alarm states that trigger a notification.
final Number	getThreshold()	The value against which the specified statistic is compared.
final String	getTreatMissingData()	Specifies how the alarm handles missing data points.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnAlarmMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnAlarmMixinProps.Builder.

Method Details

getAlarmName

public final String getAlarmName()

Description copied from interface: CfnAlarmMixinProps

The name of the alarm.

Specified by:

getAlarmName in interface CfnAlarmMixinProps

See Also:

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

getComparisonOperator

public final String getComparisonOperator()

Description copied from interface: CfnAlarmMixinProps

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

Specified by:

getComparisonOperator in interface CfnAlarmMixinProps

See Also:

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

getContactProtocols

public final List<String> getContactProtocols()

Description copied from interface: CfnAlarmMixinProps

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

Allowed Values : Email | SMS

Specified by:

getContactProtocols in interface CfnAlarmMixinProps

See Also:

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

getDatapointsToAlarm

public final Number getDatapointsToAlarm()

Description copied from interface: CfnAlarmMixinProps

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

Specified by:

getDatapointsToAlarm in interface CfnAlarmMixinProps

See Also:

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

getEvaluationPeriods

public final Number getEvaluationPeriods()

Description copied from interface: CfnAlarmMixinProps

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

Specified by:

getEvaluationPeriods in interface CfnAlarmMixinProps

See Also:

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

getMetricName

public final String getMetricName()

Description copied from interface: CfnAlarmMixinProps

The name of the metric associated with the alarm.

Specified by:

getMetricName in interface CfnAlarmMixinProps

See Also:

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

getMonitoredResourceName

public final String getMonitoredResourceName()

Description copied from interface: CfnAlarmMixinProps

The name of the Lightsail resource that the alarm monitors.

Specified by:

getMonitoredResourceName in interface CfnAlarmMixinProps

See Also:

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

getNotificationEnabled

public final Object getNotificationEnabled()

Description copied from interface: CfnAlarmMixinProps

A Boolean value indicating whether the alarm is enabled.

Returns union: either Boolean or IResolvable

Specified by:

getNotificationEnabled in interface CfnAlarmMixinProps

See Also:

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

getNotificationTriggers

public final List<String> getNotificationTriggers()

Description copied from interface: CfnAlarmMixinProps

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

Specified by:

getNotificationTriggers in interface CfnAlarmMixinProps

See Also:

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

getThreshold

public final Number getThreshold()

Description copied from interface: CfnAlarmMixinProps

The value against which the specified statistic is compared.

Specified by:

getThreshold in interface CfnAlarmMixinProps

See Also:

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

getTreatMissingData

public final String getTreatMissingData()

Description copied from interface: CfnAlarmMixinProps

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.

Specified by:

getTreatMissingData in interface CfnAlarmMixinProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object