Class: AWSCDK::CloudWatch::PromQLAlarm

Inherits:
AlarmBase
  • Object
show all
Defined in:
cloud_watch/prom_ql_alarm.rb

Overview

A CloudWatch Alarm based on a PromQL query expression.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ PromQLAlarm

Returns a new instance of PromQLAlarm.

Parameters:



13
14
15
16
17
18
19
 
# File 'cloud_watch/prom_ql_alarm.rb', line 13

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::PromQLAlarmProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5Qcm9tUUxBbGFybVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_prom_ql_alarm_arn(scope, id, alarm_arn) ⇒ AWSCDK::CloudWatch::IAlarm

Import an existing CloudWatch alarm provided an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • alarm_arn (String)

Returns:



53
54
55
56
57
58
 
# File 'cloud_watch/prom_ql_alarm.rb', line 53

def self.from_prom_ql_alarm_arn(scope, id, alarm_arn)
  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(alarm_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alarmArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudwatch.PromQLAlarm", "fromPromQLAlarmArn", [scope, id, alarm_arn])
end

.from_prom_ql_alarm_name(scope, id, alarm_name) ⇒ AWSCDK::CloudWatch::IAlarm

Import an existing CloudWatch alarm provided a Name.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • alarm_name (String)

Returns:



66
67
68
69
70
71
 
# File 'cloud_watch/prom_ql_alarm.rb', line 66

def self.from_prom_ql_alarm_name(scope, id, alarm_name)
  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(alarm_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alarmName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudwatch.PromQLAlarm", "fromPromQLAlarmName", [scope, id, alarm_name])
end

.jsii_overridable_methods ⇒ Object 



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

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 },
    :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 },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


170
171
172
 
# File 'cloud_watch/prom_ql_alarm.rb', line 170

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudwatch.PromQLAlarm", "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:



270
271
272
273
274
275
 
# File 'cloud_watch/prom_ql_alarm.rb', line 270

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:



283
284
285
286
287
288
 
# File 'cloud_watch/prom_ql_alarm.rb', line 283

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:



296
297
298
299
300
301
 
# File 'cloud_watch/prom_ql_alarm.rb', line 296

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) 


138
139
140
 
# File 'cloud_watch/prom_ql_alarm.rb', line 138

def alarm_action_arns()
  jsii_get_property("alarmActionArns")
end

#alarm_action_arns=(value) ⇒ Object 



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

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) 


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

def alarm_arn()
  jsii_get_property("alarmArn")
end

#alarm_name ⇒ String

Name of this alarm.

Returns:

  • (String) 


126
127
128
 
# File 'cloud_watch/prom_ql_alarm.rb', line 126

def alarm_name()
  jsii_get_property("alarmName")
end

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

A reference to a Alarm resource.

Returns:



133
134
135
 
# File 'cloud_watch/prom_ql_alarm.rb', line 133

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:



207
208
209
210
 
# File 'cloud_watch/prom_ql_alarm.rb', line 207

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:



224
225
226
227
 
# File 'cloud_watch/prom_ql_alarm.rb', line 224

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:



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

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


230
231
232
 
# File 'cloud_watch/prom_ql_alarm.rb', line 230

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) 


244
245
246
247
248
249
 
# File 'cloud_watch/prom_ql_alarm.rb', line 244

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) 


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

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) 


148
149
150
 
# File 'cloud_watch/prom_ql_alarm.rb', line 148

def insufficient_data_action_arns()
  jsii_get_property("insufficientDataActionArns")
end

#insufficient_data_action_arns=(value) ⇒ Object 



152
153
154
155
 
# File 'cloud_watch/prom_ql_alarm.rb', line 152

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


76
77
78
 
# File 'cloud_watch/prom_ql_alarm.rb', line 76

def node()
  jsii_get_property("node")
end

#ok_action_arns ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


158
159
160
 
# File 'cloud_watch/prom_ql_alarm.rb', line 158

def ok_action_arns()
  jsii_get_property("okActionArns")
end

#ok_action_arns=(value) ⇒ Object 



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

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) 


105
106
107
 
# File 'cloud_watch/prom_ql_alarm.rb', line 105

def physical_name()
  jsii_get_property("physicalName")
end

#render_alarm_rule ⇒ String

AlarmRule indicating ALARM state for Alarm.

Returns:

  • (String) 


306
307
308
 
# File 'cloud_watch/prom_ql_alarm.rb', line 306

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

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



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

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


177
178
179
 
# File 'cloud_watch/prom_ql_alarm.rb', line 177

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) 


190
191
192
193
194
195
 
# File 'cloud_watch/prom_ql_alarm.rb', line 190

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