Class: AWSCDK::CloudWatch::AlarmBase

Inherits:
Resource
  • Object
show all
Includes:
IAlarm
Defined in:
cloud_watch/alarm_base.rb

Overview

The base class for Alarm and CompositeAlarm resources.

Direct Known Subclasses

Alarm, CompositeAlarm, PromQLAlarm

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ AlarmBase

Returns a new instance of AlarmBase.

Parameters:



12
13
14
15
16
17
18
 
# File 'cloud_watch/alarm_base.rb', line 12

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



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

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

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:



236
237
238
239
240
241
 
# File 'cloud_watch/alarm_base.rb', line 236

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:



249
250
251
252
253
254
 
# File 'cloud_watch/alarm_base.rb', line 249

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:



262
263
264
265
266
267
 
# File 'cloud_watch/alarm_base.rb', line 262

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) 


111
112
113
 
# File 'cloud_watch/alarm_base.rb', line 111

def alarm_action_arns()
  jsii_get_property("alarmActionArns")
end

#alarm_action_arns=(value) ⇒ Object 



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

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

Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo).

Returns:

  • (String) 


92
93
94
 
# File 'cloud_watch/alarm_base.rb', line 92

def alarm_arn()
  jsii_get_property("alarmArn")
end

#alarm_name ⇒ String

Name of the alarm.

Returns:

  • (String) 


99
100
101
 
# File 'cloud_watch/alarm_base.rb', line 99

def alarm_name()
  jsii_get_property("alarmName")
end

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

A reference to a Alarm resource.

Returns:



106
107
108
 
# File 'cloud_watch/alarm_base.rb', line 106

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:



173
174
175
176
 
# File 'cloud_watch/alarm_base.rb', line 173

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:



190
191
192
193
 
# File 'cloud_watch/alarm_base.rb', line 190

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:



64
65
66
 
# File 'cloud_watch/alarm_base.rb', line 64

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


196
197
198
 
# File 'cloud_watch/alarm_base.rb', line 196

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) 


210
211
212
213
214
215
 
# File 'cloud_watch/alarm_base.rb', line 210

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) 


225
226
227
228
 
# File 'cloud_watch/alarm_base.rb', line 225

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) 


121
122
123
 
# File 'cloud_watch/alarm_base.rb', line 121

def insufficient_data_action_arns()
  jsii_get_property("insufficientDataActionArns")
end

#insufficient_data_action_arns=(value) ⇒ Object 



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

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) 


49
50
51
 
# File 'cloud_watch/alarm_base.rb', line 49

def node()
  jsii_get_property("node")
end

#ok_action_arns ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


131
132
133
 
# File 'cloud_watch/alarm_base.rb', line 131

def ok_action_arns()
  jsii_get_property("okActionArns")
end

#ok_action_arns=(value) ⇒ Object 



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

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) 


78
79
80
 
# File 'cloud_watch/alarm_base.rb', line 78

def physical_name()
  jsii_get_property("physicalName")
end

#render_alarm_rule ⇒ String

AlarmRule indicating ALARM state for Alarm.

Returns:

  • (String) 


272
273
274
 
# File 'cloud_watch/alarm_base.rb', line 272

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

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



85
86
87
 
# File 'cloud_watch/alarm_base.rb', line 85

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


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

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) 


156
157
158
159
160
161
 
# File 'cloud_watch/alarm_base.rb', line 156

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