Class: AWSCDK::CloudWatch::CfnAlarmProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_watch/cfn_alarm_props.rb

Overview

Properties for defining a CfnAlarm.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(actions_enabled: nil, alarm_actions: nil, alarm_description: nil, alarm_name: nil, comparison_operator: nil, datapoints_to_alarm: nil, dimensions: nil, evaluate_low_sample_count_percentile: nil, evaluation_criteria: nil, evaluation_interval: nil, evaluation_periods: nil, extended_statistic: nil, insufficient_data_actions: nil, metric_name: nil, metrics: nil, namespace: nil, ok_actions: nil, period: nil, statistic: nil, tags: nil, threshold: nil, threshold_metric_id: nil, treat_missing_data: nil, unit: nil) ⇒ CfnAlarmProps

Returns a new instance of CfnAlarmProps.

Parameters:

  • actions_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • alarm_actions (Array<String, AWSCDK::Interfaces::AWSAutoscaling::IScalingPolicyRef, AWSCDK::Interfaces::AWSSNS::ITopicRef>, nil) (defaults to: nil) —

    The list of actions to execute when this alarm transitions into an ALARM state from any other state.

  • alarm_description (String, nil) (defaults to: nil) —

    The description of the alarm.

  • alarm_name (String, nil) (defaults to: nil) —

    The name of the alarm.

  • comparison_operator (String, nil) (defaults to: nil) —

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

  • datapoints_to_alarm (Numeric, nil) (defaults to: nil) —

    The number of datapoints that must be breaching to trigger the alarm.

  • dimensions (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CloudWatch::CfnAlarm::DimensionProperty>, nil) (defaults to: nil) —

    The dimensions for the metric associated with the alarm.

  • evaluate_low_sample_count_percentile (String, nil) (defaults to: nil) —

    Used only for alarms based on percentiles.

  • evaluation_criteria (AWSCDK::IResolvable, AWSCDK::CloudWatch::CfnAlarm::EvaluationCriteriaProperty, nil) (defaults to: nil) —

    The evaluation criteria for an alarm.

  • evaluation_interval (Numeric, nil) (defaults to: nil) —

    The frequency, in seconds, at which the alarm is evaluated.

  • evaluation_periods (Numeric, nil) (defaults to: nil) —

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

  • extended_statistic (String, nil) (defaults to: nil) —

    The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

  • insufficient_data_actions (Array<String, AWSCDK::Interfaces::AWSSNS::ITopicRef>, nil) (defaults to: nil) —

    The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.

  • metric_name (String, nil) (defaults to: nil) —

    The name of the metric associated with the alarm.

  • metrics (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CloudWatch::CfnAlarm::MetricDataQueryProperty>, nil) (defaults to: nil) —

    An array that enables you to create an alarm based on the result of a metric math expression.

  • namespace (String, nil) (defaults to: nil) —

    The namespace of the metric associated with the alarm.

  • ok_actions (Array<String, AWSCDK::Interfaces::AWSSNS::ITopicRef>, nil) (defaults to: nil) —

    The actions to execute when this alarm transitions to the OK state from any other state.

  • period (Numeric, nil) (defaults to: nil) —

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

  • statistic (String, nil) (defaults to: nil) —

    The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic .

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of key-value pairs to associate with the alarm.

  • threshold (Numeric, nil) (defaults to: nil) —

    The value to compare with the specified statistic.

  • threshold_metric_id (String, nil) (defaults to: nil) —

    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.

  • treat_missing_data (String, nil) (defaults to: nil) —

    Sets how this alarm is to handle missing data points.

  • unit (String, nil) (defaults to: nil) —

    The unit of the metric associated with the alarm.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'cloud_watch/cfn_alarm_props.rb', line 33

def initialize(actions_enabled: nil, alarm_actions: nil, alarm_description: nil, alarm_name: nil, comparison_operator: nil, datapoints_to_alarm: nil, dimensions: nil, evaluate_low_sample_count_percentile: nil, evaluation_criteria: nil, evaluation_interval: nil, evaluation_periods: nil, extended_statistic: nil, insufficient_data_actions: nil, metric_name: nil, metrics: nil, namespace: nil, ok_actions: nil, period: nil, statistic: nil, tags: nil, threshold: nil, threshold_metric_id: nil, treat_missing_data: nil, unit: nil)
  @actions_enabled = actions_enabled
  Jsii::Type.check_type(@actions_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "actionsEnabled") unless @actions_enabled.nil?
  @alarm_actions = alarm_actions
  Jsii::Type.check_type(@alarm_actions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX2F1dG9zY2FsaW5nLklTY2FsaW5nUG9saWN5UmVmIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zbnMuSVRvcGljUmVmIn1dfX0sImtpbmQiOiJhcnJheSJ9fQ==")), "alarmActions") unless @alarm_actions.nil?
  @alarm_description = alarm_description
  Jsii::Type.check_type(@alarm_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alarmDescription") unless @alarm_description.nil?
  @alarm_name = alarm_name
  Jsii::Type.check_type(@alarm_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alarmName") unless @alarm_name.nil?
  @comparison_operator = comparison_operator
  Jsii::Type.check_type(@comparison_operator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comparisonOperator") unless @comparison_operator.nil?
  @datapoints_to_alarm = datapoints_to_alarm
  Jsii::Type.check_type(@datapoints_to_alarm, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "datapointsToAlarm") unless @datapoints_to_alarm.nil?
  @dimensions = dimensions
  Jsii::Type.check_type(@dimensions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5DZm5BbGFybS5EaW1lbnNpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "dimensions") unless @dimensions.nil?
  @evaluate_low_sample_count_percentile = evaluate_low_sample_count_percentile
  Jsii::Type.check_type(@evaluate_low_sample_count_percentile, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "evaluateLowSampleCountPercentile") unless @evaluate_low_sample_count_percentile.nil?
  @evaluation_criteria = evaluation_criteria.is_a?(Hash) ? ::AWSCDK::CloudWatch::CfnAlarm::EvaluationCriteriaProperty.new(**evaluation_criteria.transform_keys(&:to_sym)) : evaluation_criteria
  Jsii::Type.check_type(@evaluation_criteria, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZHdhdGNoLkNmbkFsYXJtLkV2YWx1YXRpb25Dcml0ZXJpYVByb3BlcnR5In1dfX0=")), "evaluationCriteria") unless @evaluation_criteria.nil?
  @evaluation_interval = evaluation_interval
  Jsii::Type.check_type(@evaluation_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "evaluationInterval") unless @evaluation_interval.nil?
  @evaluation_periods = evaluation_periods
  Jsii::Type.check_type(@evaluation_periods, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "evaluationPeriods") unless @evaluation_periods.nil?
  @extended_statistic = extended_statistic
  Jsii::Type.check_type(@extended_statistic, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "extendedStatistic") unless @extended_statistic.nil?
  @insufficient_data_actions = insufficient_data_actions
  Jsii::Type.check_type(@insufficient_data_actions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX3Nucy5JVG9waWNSZWYifV19fSwia2luZCI6ImFycmF5In19")), "insufficientDataActions") unless @insufficient_data_actions.nil?
  @metric_name = metric_name
  Jsii::Type.check_type(@metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName") unless @metric_name.nil?
  @metrics = metrics
  Jsii::Type.check_type(@metrics, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5DZm5BbGFybS5NZXRyaWNEYXRhUXVlcnlQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "metrics") unless @metrics.nil?
  @namespace = namespace
  Jsii::Type.check_type(@namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "namespace") unless @namespace.nil?
  @ok_actions = ok_actions
  Jsii::Type.check_type(@ok_actions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX3Nucy5JVG9waWNSZWYifV19fSwia2luZCI6ImFycmF5In19")), "okActions") unless @ok_actions.nil?
  @period = period
  Jsii::Type.check_type(@period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "period") unless @period.nil?
  @statistic = statistic
  Jsii::Type.check_type(@statistic, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "statistic") unless @statistic.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @threshold = threshold
  Jsii::Type.check_type(@threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "threshold") unless @threshold.nil?
  @threshold_metric_id = threshold_metric_id
  Jsii::Type.check_type(@threshold_metric_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "thresholdMetricId") unless @threshold_metric_id.nil?
  @treat_missing_data = treat_missing_data
  Jsii::Type.check_type(@treat_missing_data, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "treatMissingData") unless @treat_missing_data.nil?
  @unit = unit
  Jsii::Type.check_type(@unit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "unit") unless @unit.nil?
end

Instance Attribute Details

#actions_enabled ⇒ Boolean, ... (readonly)

Note:

Default: - true

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

The default is TRUE.

Returns:

See Also:



91
92
93
 
# File 'cloud_watch/cfn_alarm_props.rb', line 91

def actions_enabled
  @actions_enabled
end

#alarm_actions ⇒ Array<String, AWSCDK::Interfaces::AWSAutoscaling::IScalingPolicyRef, AWSCDK::Interfaces::AWSSNS::ITopicRef>? (readonly)

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:

See Also:



98
99
100
 
# File 'cloud_watch/cfn_alarm_props.rb', line 98

def alarm_actions
  @alarm_actions
end

#alarm_description ⇒ String? (readonly)

The description of the alarm.

Returns:

  • (String, nil)

See Also:



103
104
105
 
# File 'cloud_watch/cfn_alarm_props.rb', line 103

def alarm_description
  @alarm_description
end

#alarm_name ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



112
113
114
 
# File 'cloud_watch/cfn_alarm_props.rb', line 112

def alarm_name
  @alarm_name
end

#comparison_operator ⇒ String? (readonly)

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

The specified statistic value is used as the first operand.

Returns:

  • (String, nil)

See Also:



119
120
121
 
# File 'cloud_watch/cfn_alarm_props.rb', line 119

def comparison_operator
  @comparison_operator
end

#datapoints_to_alarm ⇒ Numeric? (readonly)

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.

Returns:

  • (Numeric, nil)

See Also:



128
129
130
 
# File 'cloud_watch/cfn_alarm_props.rb', line 128

def datapoints_to_alarm
  @datapoints_to_alarm
end

#dimensions ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



135
136
137
 
# File 'cloud_watch/cfn_alarm_props.rb', line 135

def dimensions
  @dimensions
end

#evaluate_low_sample_count_percentile ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



142
143
144
 
# File 'cloud_watch/cfn_alarm_props.rb', line 142

def evaluate_low_sample_count_percentile
  @evaluate_low_sample_count_percentile
end

#evaluation_criteria ⇒ AWSCDK::IResolvable, ... (readonly)

The evaluation criteria for an alarm.

This is a union type that currently supports PromQLCriteria.

Returns:

See Also:



149
150
151
 
# File 'cloud_watch/cfn_alarm_props.rb', line 149

def evaluation_criteria
  @evaluation_criteria
end

#evaluation_interval ⇒ Numeric? (readonly)

The frequency, in seconds, at which the alarm is evaluated.

Returns:

  • (Numeric, nil)

See Also:



154
155
156
 
# File 'cloud_watch/cfn_alarm_props.rb', line 154

def evaluation_interval
  @evaluation_interval
end

#evaluation_periods ⇒ Numeric? (readonly)

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 .

Returns:

  • (Numeric, nil)

See Also:



163
164
165
 
# File 'cloud_watch/cfn_alarm_props.rb', line 163

def evaluation_periods
  @evaluation_periods
end

#extended_statistic ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



172
173
174
 
# File 'cloud_watch/cfn_alarm_props.rb', line 172

def extended_statistic
  @extended_statistic
end

#insufficient_data_actions ⇒ Array<String, AWSCDK::Interfaces::AWSSNS::ITopicRef>? (readonly)

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:

See Also:



179
180
181
 
# File 'cloud_watch/cfn_alarm_props.rb', line 179

def insufficient_data_actions
  @insufficient_data_actions
end

#metric_name ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



186
187
188
 
# File 'cloud_watch/cfn_alarm_props.rb', line 186

def metric_name
  @metric_name
end

#metrics ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



195
196
197
 
# File 'cloud_watch/cfn_alarm_props.rb', line 195

def metrics
  @metrics
end

#namespace ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



204
205
206
 
# File 'cloud_watch/cfn_alarm_props.rb', line 204

def namespace
  @namespace
end

#ok_actions ⇒ Array<String, AWSCDK::Interfaces::AWSSNS::ITopicRef>? (readonly)

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:

See Also:



211
212
213
 
# File 'cloud_watch/cfn_alarm_props.rb', line 211

def ok_actions
  @ok_actions
end

#period ⇒ Numeric? (readonly)

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

Returns:

  • (Numeric, nil)

See Also:



222
223
224
 
# File 'cloud_watch/cfn_alarm_props.rb', line 222

def period
  @period
end

#statistic ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



231
232
233
 
# File 'cloud_watch/cfn_alarm_props.rb', line 231

def statistic
  @statistic
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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.

Returns:

See Also:



240
241
242
 
# File 'cloud_watch/cfn_alarm_props.rb', line 240

def tags
  @tags
end

#threshold ⇒ Numeric? (readonly)

The value to compare with the specified statistic.

Returns:

  • (Numeric, nil)

See Also:



245
246
247
 
# File 'cloud_watch/cfn_alarm_props.rb', line 245

def threshold
  @threshold
end

#threshold_metric_id ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



250
251
252
 
# File 'cloud_watch/cfn_alarm_props.rb', line 250

def threshold_metric_id
  @threshold_metric_id
end

#treat_missing_data ⇒ String? (readonly)

Sets how this alarm is to handle missing data points.

Valid values are breaching , not_breaching , 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.

Returns:

  • (String, nil)

See Also:



259
260
261
 
# File 'cloud_watch/cfn_alarm_props.rb', line 259

def treat_missing_data
  @treat_missing_data
end

#unit ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



268
269
270
 
# File 'cloud_watch/cfn_alarm_props.rb', line 268

def unit
  @unit
end

Class Method Details

.jsii_properties ⇒ Object 



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'cloud_watch/cfn_alarm_props.rb', line 270

def self.jsii_properties
  {
    :actions_enabled => "actionsEnabled",
    :alarm_actions => "alarmActions",
    :alarm_description => "alarmDescription",
    :alarm_name => "alarmName",
    :comparison_operator => "comparisonOperator",
    :datapoints_to_alarm => "datapointsToAlarm",
    :dimensions => "dimensions",
    :evaluate_low_sample_count_percentile => "evaluateLowSampleCountPercentile",
    :evaluation_criteria => "evaluationCriteria",
    :evaluation_interval => "evaluationInterval",
    :evaluation_periods => "evaluationPeriods",
    :extended_statistic => "extendedStatistic",
    :insufficient_data_actions => "insufficientDataActions",
    :metric_name => "metricName",
    :metrics => "metrics",
    :namespace => "namespace",
    :ok_actions => "okActions",
    :period => "period",
    :statistic => "statistic",
    :tags => "tags",
    :threshold => "threshold",
    :threshold_metric_id => "thresholdMetricId",
    :treat_missing_data => "treatMissingData",
    :unit => "unit",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'cloud_watch/cfn_alarm_props.rb', line 299

def to_jsii
  result = {}
  result.merge!({
    "actionsEnabled" => @actions_enabled,
    "alarmActions" => @alarm_actions,
    "alarmDescription" => @alarm_description,
    "alarmName" => @alarm_name,
    "comparisonOperator" => @comparison_operator,
    "datapointsToAlarm" => @datapoints_to_alarm,
    "dimensions" => @dimensions,
    "evaluateLowSampleCountPercentile" => @evaluate_low_sample_count_percentile,
    "evaluationCriteria" => @evaluation_criteria,
    "evaluationInterval" => @evaluation_interval,
    "evaluationPeriods" => @evaluation_periods,
    "extendedStatistic" => @extended_statistic,
    "insufficientDataActions" => @insufficient_data_actions,
    "metricName" => @metric_name,
    "metrics" => @metrics,
    "namespace" => @namespace,
    "okActions" => @ok_actions,
    "period" => @period,
    "statistic" => @statistic,
    "tags" => @tags,
    "threshold" => @threshold,
    "thresholdMetricId" => @threshold_metric_id,
    "treatMissingData" => @treat_missing_data,
    "unit" => @unit,
  })
  result.compact
end