Package software.amazon.awscdk.services.cloudwatch

Class CfnAlarmProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudwatch.CfnAlarmProps.Jsii$Proxy

All Implemented Interfaces:

CfnAlarmProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAlarmProps

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

An implementation for CfnAlarmProps

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.services.cloudwatch.CfnAlarmProps

CfnAlarmProps.Builder, CfnAlarmProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAlarmProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAlarmProps.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 Object	getActionsEnabled()	Indicates whether actions should be executed during any changes to the alarm state.
final List<Object>	getAlarmActions()	The list of actions to execute when this alarm transitions into an ALARM state from any other state.
final String	getAlarmDescription()	The description of the alarm.
final String	getAlarmName()	The name of the alarm.
final String	getComparisonOperator()	The arithmetic operation to use when comparing the specified statistic and threshold.
final Number	getDatapointsToAlarm()	The number of datapoints that must be breaching to trigger the alarm.
final Object	getDimensions()	The dimensions for the metric associated with the alarm.
final String	getEvaluateLowSampleCountPercentile()	Used only for alarms based on percentiles.
final Number	getEvaluationPeriods()	The number of periods over which data is compared to the specified threshold.
final String	getExtendedStatistic()	The percentile statistic for the metric associated with the alarm.
final List<Object>	getInsufficientDataActions()	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
final String	getMetricName()	The name of the metric associated with the alarm.
final Object	getMetrics()	An array that enables you to create an alarm based on the result of a metric math expression.
final String	getNamespace()	The namespace of the metric associated with the alarm.
final List<Object>	getOkActions()	The actions to execute when this alarm transitions to the OK state from any other state.
final Number	getPeriod()	The period, in seconds, over which the statistic is applied.
final String	getStatistic()	The statistic for the metric associated with the alarm, other than percentile.
final List<CfnTag>	getTags()	A list of key-value pairs to associate with the alarm.
final Number	getThreshold()	The value to compare with the specified statistic.
final String	getThresholdMetricId()	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.
final String	getTreatMissingData()	Sets how this alarm is to handle missing data points.
final String	getUnit()	The unit of the metric associated with the alarm.
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(CfnAlarmProps.Builder builder)

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

Method Details

getComparisonOperator

public final String getComparisonOperator()

Description copied from interface: CfnAlarmProps

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

The specified statistic value is used as the first operand.

Specified by:

getComparisonOperator in interface CfnAlarmProps

See Also:

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

getEvaluationPeriods

public final Number getEvaluationPeriods()

Description copied from interface: CfnAlarmProps

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 .

Specified by:

getEvaluationPeriods in interface CfnAlarmProps

See Also:

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

getActionsEnabled

public final Object getActionsEnabled()

Description copied from interface: CfnAlarmProps

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

The default is TRUE.

Returns union: either Boolean or IResolvable

Default: - true

Specified by:

getActionsEnabled in interface CfnAlarmProps

See Also:

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

getAlarmActions

public final List<Object> getAlarmActions()

Description copied from interface: CfnAlarmProps

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 .

Returns union: Listinvalid input: '<'either String or IScalingPolicyRef or ITopicRef>

Specified by:

getAlarmActions in interface CfnAlarmProps

See Also:

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

getAlarmDescription

public final String getAlarmDescription()

Description copied from interface: CfnAlarmProps

The description of the alarm.

Specified by:

getAlarmDescription in interface CfnAlarmProps

See Also:

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

getAlarmName

public final String getAlarmName()

Description copied from interface: CfnAlarmProps

The name of the alarm.

If you don't specify a name, 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.

Specified by:

getAlarmName in interface CfnAlarmProps

See Also:

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

getDatapointsToAlarm

public final Number getDatapointsToAlarm()

Description copied from interface: CfnAlarmProps

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.

Specified by:

getDatapointsToAlarm in interface CfnAlarmProps

See Also:

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

getDimensions

public final Object getDimensions()

Description copied from interface: CfnAlarmProps

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 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAlarm.DimensionProperty>

Specified by:

getDimensions in interface CfnAlarmProps

See Also:

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

getEvaluateLowSampleCountPercentile

public final String getEvaluateLowSampleCountPercentile()

Description copied from interface: CfnAlarmProps

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.

Specified by:

getEvaluateLowSampleCountPercentile in interface CfnAlarmProps

See Also:

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

getExtendedStatistic

public final String getExtendedStatistic()

Description copied from interface: CfnAlarmProps

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 .

Specified by:

getExtendedStatistic in interface CfnAlarmProps

See Also:

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

getInsufficientDataActions

public final List<Object> getInsufficientDataActions()

Description copied from interface: CfnAlarmProps

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).

Returns union: Listinvalid input: '<'either String or ITopicRef>

Specified by:

getInsufficientDataActions in interface CfnAlarmProps

See Also:

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

getMetricName

public final String getMetricName()

Description copied from interface: CfnAlarmProps

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 .

Specified by:

getMetricName in interface CfnAlarmProps

See Also:

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

getMetrics

public final Object getMetrics()

Description copied from interface: CfnAlarmProps

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 .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAlarm.MetricDataQueryProperty>

Specified by:

getMetrics in interface CfnAlarmProps

See Also:

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

getNamespace

public final String getNamespace()

Description copied from interface: CfnAlarmProps

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.

Specified by:

getNamespace in interface CfnAlarmProps

See Also:

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

getOkActions

public final List<Object> getOkActions()

Description copied from interface: CfnAlarmProps

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).

Returns union: Listinvalid input: '<'either String or ITopicRef>

Specified by:

getOkActions in interface CfnAlarmProps

See Also:

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

getPeriod

public final Number getPeriod()

Description copied from interface: CfnAlarmProps

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

This is required for an alarm based on a metric. Valid values are 10, 20, 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

Specified by:

getPeriod in interface CfnAlarmProps

See Also:

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

getStatistic

public final String getStatistic()

Description copied from interface: CfnAlarmProps

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 .

Specified by:

getStatistic in interface CfnAlarmProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnAlarmProps

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.

Specified by:

getTags in interface CfnAlarmProps

See Also:

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

getThreshold

public final Number getThreshold()

Description copied from interface: CfnAlarmProps

The value to compare with the specified statistic.

Specified by:

getThreshold in interface CfnAlarmProps

See Also:

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

getThresholdMetricId

public final String getThresholdMetricId()

Description copied from interface: CfnAlarmProps

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.

Specified by:

getThresholdMetricId in interface CfnAlarmProps

See Also:

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

getTreatMissingData

public final String getTreatMissingData()

Description copied from interface: CfnAlarmProps

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.

Specified by:

getTreatMissingData in interface CfnAlarmProps

See Also:

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

getUnit

public final String getUnit()

Description copied from interface: CfnAlarmProps

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.

Specified by:

getUnit in interface CfnAlarmProps

See Also:

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

$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