CfnAlarmProps.Jsii$Proxy

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.cloudwatch.CfnAlarmProps.Jsii$Proxy

All Implemented Interfaces:: CfnAlarmProps

Enclosing interface:: CfnAlarmProps

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 interface software.amazon.awscdk.services.cloudwatch.CfnAlarmProps
  CfnAlarmProps.Builder, CfnAlarmProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Object`	`getActionsEnabled()` Indicates whether actions should be executed during any changes to the alarm state.
`java.util.List<java.lang.String>`	`getAlarmActions()` The list of actions to execute when this alarm transitions into an ALARM state from any other state.
`java.lang.String`	`getAlarmDescription()` The description of the alarm.
`java.lang.String`	`getAlarmName()` The name of the alarm.
`java.lang.String`	`getComparisonOperator()` The arithmetic operation to use when comparing the specified statistic and threshold.
`java.lang.Number`	`getDatapointsToAlarm()` The number of datapoints that must be breaching to trigger the alarm.
`java.lang.Object`	`getDimensions()` The dimensions for the metric associated with the alarm.
`java.lang.String`	`getEvaluateLowSampleCountPercentile()` Used only for alarms based on percentiles.
`java.lang.Number`	`getEvaluationPeriods()` The number of periods over which data is compared to the specified threshold.
`java.lang.String`	`getExtendedStatistic()` The percentile statistic for the metric associated with the alarm.
`java.util.List<java.lang.String>`	`getInsufficientDataActions()` The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
`java.lang.String`	`getMetricName()` The name of the metric associated with the alarm.
`java.lang.Object`	`getMetrics()` An array that enables you to create an alarm based on the result of a metric math expression.
`java.lang.String`	`getNamespace()` The namespace of the metric associated with the alarm.
`java.util.List<java.lang.String>`	`getOkActions()` The actions to execute when this alarm transitions to the `OK` state from any other state.
`java.lang.Number`	`getPeriod()` The period, in seconds, over which the statistic is applied.
`java.lang.String`	`getStatistic()` The statistic for the metric associated with the alarm, other than percentile.
`java.lang.Number`	`getThreshold()` The value to compare with the specified statistic.
`java.lang.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.
`java.lang.String`	`getTreatMissingData()` Sets how this alarm is to handle missing data points.
`java.lang.String`	`getUnit()` The unit of the metric associated with the alarm.
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.CfnAlarmProps
builder

- Constructor Detail
  - 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.
- Method Detail
  - getComparisonOperator
```
public final java.lang.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.
    You can specify the following values: GreaterThanThreshold , GreaterThanOrEqualToThreshold , LessThanThreshold , or LessThanOrEqualToThreshold .
    
    Specified by:
    
    getComparisonOperator in interface CfnAlarmProps
  - getEvaluationPeriods
```
public final java.lang.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
  - getActionsEnabled
```
public final java.lang.Object getActionsEnabled()
```
    Description copied from interface: CfnAlarmProps
    
    Indicates whether actions should be executed during any changes to the alarm state.
    The default is TRUE.
    
    Specified by:
    
    getActionsEnabled in interface CfnAlarmProps
  - getAlarmActions
```
public final java.util.List<java.lang.String> 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 .
    
    Specified by:
    
    getAlarmActions in interface CfnAlarmProps
  - getAlarmDescription
```
public final java.lang.String getAlarmDescription()
```
    Description copied from interface: CfnAlarmProps
    
    The description of the alarm.
    
    Specified by:
    
    getAlarmDescription in interface CfnAlarmProps
  - getAlarmName
```
public final java.lang.String getAlarmName()
```
    Description copied from interface: CfnAlarmProps
    
    The name of the alarm.
    If you don't specify a name, AWS 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
  - getDatapointsToAlarm
```
public final java.lang.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
  - getDimensions
```
public final java.lang.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 .
    
    Specified by:
    
    getDimensions in interface CfnAlarmProps
  - getEvaluateLowSampleCountPercentile
```
public final java.lang.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
  - getExtendedStatistic
```
public final java.lang.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
  - getInsufficientDataActions
```
public final java.util.List<java.lang.String> 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).
    
    Specified by:
    
    getInsufficientDataActions in interface CfnAlarmProps
  - getMetricName
```
public final java.lang.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
  - getMetrics
```
public final java.lang.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 .
    
    Specified by:
    
    getMetrics in interface CfnAlarmProps
  - getNamespace
```
public final java.lang.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
  - getOkActions
```
public final java.util.List<java.lang.String> 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).
    
    Specified by:
    
    getOkActions in interface CfnAlarmProps
  - getPeriod
```
public final java.lang.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, 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
  - getStatistic
```
public final java.lang.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
  - getThreshold
```
public final java.lang.Number getThreshold()
```
    Description copied from interface: CfnAlarmProps
    
    The value to compare with the specified statistic.
    
    Specified by:
    
    getThreshold in interface CfnAlarmProps
  - getThresholdMetricId
```
public final java.lang.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
  - getTreatMissingData
```
public final java.lang.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
  - getUnit
```
public final java.lang.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
  - $jsii$toJson
```
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
  - equals
```
public final boolean equals(java.lang.Object o)
```
  - hashCode
```
public final int hashCode()
```

Class CfnAlarmProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.CfnAlarmProps

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.CfnAlarmProps

Constructor Detail

Jsii$Proxy

Method Detail

getComparisonOperator

getEvaluationPeriods

getActionsEnabled

getAlarmActions

getAlarmDescription

getAlarmName

getDatapointsToAlarm

getDimensions

getEvaluateLowSampleCountPercentile

getExtendedStatistic

getInsufficientDataActions

getMetricName

getMetrics

getNamespace

getOkActions

getPeriod

getStatistic

getThreshold

getThresholdMetricId

getTreatMissingData

getUnit

$jsii$toJson

equals

hashCode