Class: AWSCDK::CloudWatch::AnomalyDetectionAlarm

Inherits:
Alarm
  • Object
show all
Defined in:
cloud_watch/anomaly_detection_alarm.rb

Overview

CloudWatch Alarm that uses anomaly detection to trigger alarms.

This alarm type is specifically designed for use with anomaly detection operators like LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ AnomalyDetectionAlarm

Returns a new instance of AnomalyDetectionAlarm.

Parameters:



14
15
16
17
18
19
20
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 14

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::AnomalyDetectionAlarmProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5Bbm9tYWx5RGV0ZWN0aW9uQWxhcm1Qcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 22

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :alarm_arn => { kind: :property, name: "alarmArn", is_optional: false },
    :alarm_name => { kind: :property, name: "alarmName", is_optional: false },
    :alarm_ref => { kind: :property, name: "alarmRef", is_optional: false },
    :alarm_action_arns => { kind: :property, name: "alarmActionArns", is_optional: true },
    :insufficient_data_action_arns => { kind: :property, name: "insufficientDataActionArns", is_optional: true },
    :ok_action_arns => { kind: :property, name: "okActionArns", is_optional: true },
    :metric => { kind: :property, name: "metric", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_alarm_action => { kind: :method, name: "addAlarmAction", is_optional: false },
    :add_insufficient_data_action => { kind: :method, name: "addInsufficientDataAction", is_optional: false },
    :add_ok_action => { kind: :method, name: "addOkAction", is_optional: false },
    :render_alarm_rule => { kind: :method, name: "renderAlarmRule", is_optional: false },
    :to_annotation => { kind: :method, name: "toAnnotation", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


147
148
149
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 147

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudwatch.AnomalyDetectionAlarm", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_alarm_action(*actions) ⇒ void

This method returns an undefined value.

Trigger this action if the alarm fires.

Typically SnsAction or AutoScalingAction.

Parameters:



254
255
256
257
258
259
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 254

def add_alarm_action(*actions)
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5JQWxhcm1BY3Rpb24ifQ==")), "actions[#{index}]")
  end
  jsii_call_method("addAlarmAction", [*actions])
end

#add_insufficient_data_action(*actions) ⇒ void

This method returns an undefined value.

Trigger this action if there is insufficient data to evaluate the alarm.

Typically SnsAction or AutoScalingAction.

Parameters:



267
268
269
270
271
272
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 267

def add_insufficient_data_action(*actions)
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5JQWxhcm1BY3Rpb24ifQ==")), "actions[#{index}]")
  end
  jsii_call_method("addInsufficientDataAction", [*actions])
end

#add_ok_action(*actions) ⇒ void

This method returns an undefined value.

Trigger this action if the alarm returns from breaching state into ok state.

Typically SnsAction or AutoScalingAction.

Parameters:



280
281
282
283
284
285
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 280

def add_ok_action(*actions)
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5JQWxhcm1BY3Rpb24ifQ==")), "actions[#{index}]")
  end
  jsii_call_method("addOkAction", [*actions])
end

#alarm_action_arns ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


115
116
117
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 115

def alarm_action_arns()
  jsii_get_property("alarmActionArns")
end

#alarm_action_arns=(value) ⇒ Object 



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

def alarm_action_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "alarmActionArns") unless value.nil?
  jsii_set_property("alarmActionArns", value)
end

#alarm_arn ⇒ String

ARN of this alarm.

Returns:

  • (String) 


96
97
98
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 96

def alarm_arn()
  jsii_get_property("alarmArn")
end

#alarm_name ⇒ String

Name of this alarm.

Returns:

  • (String) 


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

def alarm_name()
  jsii_get_property("alarmName")
end

#alarm_ref ⇒ AWSCDK::Interfaces::AWSCloudwatch::AlarmReference

A reference to a Alarm resource.

Returns:



110
111
112
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 110

def alarm_ref()
  jsii_get_property("alarmRef")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



191
192
193
194
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 191

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



208
209
210
211
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 208

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



68
69
70
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 68

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


214
215
216
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 214

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


228
229
230
231
232
233
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 228

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


243
244
245
246
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 243

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#insufficient_data_action_arns ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


125
126
127
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 125

def insufficient_data_action_arns()
  jsii_get_property("insufficientDataActionArns")
end

#insufficient_data_action_arns=(value) ⇒ Object 



129
130
131
132
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 129

def insufficient_data_action_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "insufficientDataActionArns") unless value.nil?
  jsii_set_property("insufficientDataActionArns", value)
end

#metric ⇒ AWSCDK::CloudWatch::IMetric

The metric object this alarm was based on.

Returns:



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

def metric()
  jsii_get_property("metric")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


53
54
55
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 53

def node()
  jsii_get_property("node")
end

#ok_action_arns ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

def ok_action_arns()
  jsii_get_property("okActionArns")
end

#ok_action_arns=(value) ⇒ Object 



139
140
141
142
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 139

def ok_action_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "okActionArns") unless value.nil?
  jsii_set_property("okActionArns", value)
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


82
83
84
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 82

def physical_name()
  jsii_get_property("physicalName")
end

#render_alarm_rule ⇒ String

AlarmRule indicating ALARM state for Alarm.

Returns:

  • (String) 


290
291
292
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 290

def render_alarm_rule()
  jsii_call_method("renderAlarmRule", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



89
90
91
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 89

def stack()
  jsii_get_property("stack")
end

#to_annotation ⇒ AWSCDK::CloudWatch::HorizontalAnnotation

Turn this alarm into a horizontal annotation.

This is useful if you want to represent an Alarm in a non-AlarmWidget. An AlarmWidget can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph.

This might be useful if:

  • You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm.
  • You want to show an Alarm line in a graph with multiple metrics in it.

Returns:



309
310
311
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 309

def to_annotation()
  jsii_call_method("toAnnotation", [])
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


161
162
163
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 161

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


174
175
176
177
178
179
 
# File 'cloud_watch/anomaly_detection_alarm.rb', line 174

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end