Class: AWSCDK::CloudWatch::CfnAlarm

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSCloudwatch::IAlarmRef
Defined in:
cloud_watch/cfn_alarm.rb

Overview

The AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA . The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::CloudWatch::Alarm.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::CloudWatch::CfnAlarmProps, nil) (defaults to: nil) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'cloud_watch/cfn_alarm.rb', line 22

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

Class Method Details

.arn_for_alarm(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_alarm(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbG91ZHdhdGNoLklBbGFybVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudwatch.CfnAlarm", "arnForAlarm", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


232
233
234
 
# File 'cloud_watch/cfn_alarm.rb', line 232

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

.from_alarm_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSCloudwatch::IAlarmRef

Creates a new IAlarmRef from an ARN.

Parameters:

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

Returns:



110
111
112
113
114
115
 
# File 'cloud_watch/cfn_alarm.rb', line 110

def self.from_alarm_arn(scope, id, 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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudwatch.CfnAlarm", "fromAlarmArn", [scope, id, arn])
end

.from_alarm_name(scope, id, alarm_name) ⇒ AWSCDK::Interfaces::AWSCloudwatch::IAlarmRef

Creates a new IAlarmRef from a alarmName.

Parameters:

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

Returns:



123
124
125
126
127
128
 
# File 'cloud_watch/cfn_alarm.rb', line 123

def self.from_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.CfnAlarm", "fromAlarmName", [scope, id, alarm_name])
end

.is_cfn_alarm(x) ⇒ Boolean

Checks whether the given object is a CfnAlarm.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_alarm(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudwatch.CfnAlarm", "isCfnAlarm", [x])
end

.jsii_overridable_methods ⇒ Object 



30
31
32
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
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'cloud_watch/cfn_alarm.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :alarm_ref => { kind: :property, name: "alarmRef", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :actions_enabled => { kind: :property, name: "actionsEnabled", is_optional: true },
    :alarm_actions => { kind: :property, name: "alarmActions", is_optional: true },
    :alarm_description => { kind: :property, name: "alarmDescription", is_optional: true },
    :alarm_name => { kind: :property, name: "alarmName", is_optional: true },
    :comparison_operator => { kind: :property, name: "comparisonOperator", is_optional: true },
    :datapoints_to_alarm => { kind: :property, name: "datapointsToAlarm", is_optional: true },
    :dimensions => { kind: :property, name: "dimensions", is_optional: true },
    :evaluate_low_sample_count_percentile => { kind: :property, name: "evaluateLowSampleCountPercentile", is_optional: true },
    :evaluation_criteria => { kind: :property, name: "evaluationCriteria", is_optional: true },
    :evaluation_interval => { kind: :property, name: "evaluationInterval", is_optional: true },
    :evaluation_periods => { kind: :property, name: "evaluationPeriods", is_optional: true },
    :extended_statistic => { kind: :property, name: "extendedStatistic", is_optional: true },
    :insufficient_data_actions => { kind: :property, name: "insufficientDataActions", is_optional: true },
    :metric_name => { kind: :property, name: "metricName", is_optional: true },
    :metrics => { kind: :property, name: "metrics", is_optional: true },
    :namespace => { kind: :property, name: "namespace", is_optional: true },
    :ok_actions => { kind: :property, name: "okActions", is_optional: true },
    :period => { kind: :property, name: "period", is_optional: true },
    :statistic => { kind: :property, name: "statistic", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :threshold => { kind: :property, name: "threshold", is_optional: true },
    :threshold_metric_id => { kind: :property, name: "thresholdMetricId", is_optional: true },
    :treat_missing_data => { kind: :property, name: "treatMissingData", is_optional: true },
    :unit => { kind: :property, name: "unit", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#actions_enabled ⇒ Boolean, ...

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

Returns:



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

def actions_enabled()
  jsii_get_property("actionsEnabled")
end

#actions_enabled=(value) ⇒ Object 



264
265
266
267
 
# File 'cloud_watch/cfn_alarm.rb', line 264

def actions_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "actionsEnabled") unless value.nil?
  jsii_set_property("actionsEnabled", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



587
588
589
590
 
# File 'cloud_watch/cfn_alarm.rb', line 587

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



599
600
601
602
 
# File 'cloud_watch/cfn_alarm.rb', line 599

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



609
610
611
612
 
# File 'cloud_watch/cfn_alarm.rb', line 609

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



620
621
622
623
624
 
# File 'cloud_watch/cfn_alarm.rb', line 620

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


677
678
679
680
681
 
# File 'cloud_watch/cfn_alarm.rb', line 677

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



687
688
689
690
 
# File 'cloud_watch/cfn_alarm.rb', line 687

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



699
700
701
702
703
 
# File 'cloud_watch/cfn_alarm.rb', line 699

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#alarm_actions ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


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

def alarm_actions()
  jsii_get_property("alarmActions")
end

#alarm_actions=(value) ⇒ Object 



276
277
278
279
 
# File 'cloud_watch/cfn_alarm.rb', line 276

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

#alarm_description ⇒ String?

The description of the alarm.

Returns:

  • (String, nil) 


284
285
286
 
# File 'cloud_watch/cfn_alarm.rb', line 284

def alarm_description()
  jsii_get_property("alarmDescription")
end

#alarm_description=(value) ⇒ Object 



288
289
290
291
 
# File 'cloud_watch/cfn_alarm.rb', line 288

def alarm_description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alarmDescription") unless value.nil?
  jsii_set_property("alarmDescription", value)
end

#alarm_name ⇒ String?

The name of the alarm.

Returns:

  • (String, nil) 


296
297
298
 
# File 'cloud_watch/cfn_alarm.rb', line 296

def alarm_name()
  jsii_get_property("alarmName")
end

#alarm_name=(value) ⇒ Object 



300
301
302
303
 
# File 'cloud_watch/cfn_alarm.rb', line 300

def alarm_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alarmName") unless value.nil?
  jsii_set_property("alarmName", value)
end

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

A reference to a Alarm resource.

Returns:



239
240
241
 
# File 'cloud_watch/cfn_alarm.rb', line 239

def alarm_ref()
  jsii_get_property("alarmRef")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



712
713
714
715
 
# File 'cloud_watch/cfn_alarm.rb', line 712

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



734
735
736
737
738
739
 
# File 'cloud_watch/cfn_alarm.rb', line 734

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN of the CloudWatch alarm, such as arn:aws:cloudwatch:us-west-2:123456789012:alarm:myCloudWatchAlarm-CPUAlarm-UXMMZK36R55Z .

Returns:

  • (String) 


246
247
248
 
# File 'cloud_watch/cfn_alarm.rb', line 246

def attr_arn()
  jsii_get_property("attrArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



253
254
255
 
# File 'cloud_watch/cfn_alarm.rb', line 253

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



185
186
187
 
# File 'cloud_watch/cfn_alarm.rb', line 185

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


743
744
745
746
 
# File 'cloud_watch/cfn_alarm.rb', line 743

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


202
203
204
 
# File 'cloud_watch/cfn_alarm.rb', line 202

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#comparison_operator ⇒ String?

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

Returns:

  • (String, nil) 


308
309
310
 
# File 'cloud_watch/cfn_alarm.rb', line 308

def comparison_operator()
  jsii_get_property("comparisonOperator")
end

#comparison_operator=(value) ⇒ Object 



312
313
314
315
 
# File 'cloud_watch/cfn_alarm.rb', line 312

def comparison_operator=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comparisonOperator") unless value.nil?
  jsii_set_property("comparisonOperator", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#datapoints_to_alarm ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


320
321
322
 
# File 'cloud_watch/cfn_alarm.rb', line 320

def datapoints_to_alarm()
  jsii_get_property("datapointsToAlarm")
end

#datapoints_to_alarm=(value) ⇒ Object 



324
325
326
327
 
# File 'cloud_watch/cfn_alarm.rb', line 324

def datapoints_to_alarm=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "datapointsToAlarm") unless value.nil?
  jsii_set_property("datapointsToAlarm", value)
end

#dimensions ⇒ AWSCDK::IResolvable, ...

The dimensions for the metric associated with the alarm.

Returns:



332
333
334
 
# File 'cloud_watch/cfn_alarm.rb', line 332

def dimensions()
  jsii_get_property("dimensions")
end

#dimensions=(value) ⇒ Object 



336
337
338
339
 
# File 'cloud_watch/cfn_alarm.rb', line 336

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

def env()
  jsii_get_property("env")
end

#evaluate_low_sample_count_percentile ⇒ String?

Used only for alarms based on percentiles.

Returns:

  • (String, nil) 


344
345
346
 
# File 'cloud_watch/cfn_alarm.rb', line 344

def evaluate_low_sample_count_percentile()
  jsii_get_property("evaluateLowSampleCountPercentile")
end

#evaluate_low_sample_count_percentile=(value) ⇒ Object 



348
349
350
351
 
# File 'cloud_watch/cfn_alarm.rb', line 348

def evaluate_low_sample_count_percentile=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "evaluateLowSampleCountPercentile") unless value.nil?
  jsii_set_property("evaluateLowSampleCountPercentile", value)
end

#evaluation_criteria ⇒ AWSCDK::IResolvable, ...

The evaluation criteria for an alarm.

Returns:



356
357
358
 
# File 'cloud_watch/cfn_alarm.rb', line 356

def evaluation_criteria()
  jsii_get_property("evaluationCriteria")
end

#evaluation_criteria=(value) ⇒ Object 



360
361
362
363
364
 
# File 'cloud_watch/cfn_alarm.rb', line 360

def evaluation_criteria=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CloudWatch::CfnAlarm::EvaluationCriteriaProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZHdhdGNoLkNmbkFsYXJtLkV2YWx1YXRpb25Dcml0ZXJpYVByb3BlcnR5In1dfX0=")), "evaluationCriteria") unless value.nil?
  jsii_set_property("evaluationCriteria", value)
end

#evaluation_interval ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


369
370
371
 
# File 'cloud_watch/cfn_alarm.rb', line 369

def evaluation_interval()
  jsii_get_property("evaluationInterval")
end

#evaluation_interval=(value) ⇒ Object 



373
374
375
376
 
# File 'cloud_watch/cfn_alarm.rb', line 373

def evaluation_interval=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "evaluationInterval") unless value.nil?
  jsii_set_property("evaluationInterval", value)
end

#evaluation_periods ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


381
382
383
 
# File 'cloud_watch/cfn_alarm.rb', line 381

def evaluation_periods()
  jsii_get_property("evaluationPeriods")
end

#evaluation_periods=(value) ⇒ Object 



385
386
387
388
 
# File 'cloud_watch/cfn_alarm.rb', line 385

def evaluation_periods=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "evaluationPeriods") unless value.nil?
  jsii_set_property("evaluationPeriods", value)
end

#extended_statistic ⇒ String?

The percentile statistic for the metric associated with the alarm.

Specify a value between p0.0 and p100.

Returns:

  • (String, nil) 


395
396
397
 
# File 'cloud_watch/cfn_alarm.rb', line 395

def extended_statistic()
  jsii_get_property("extendedStatistic")
end

#extended_statistic=(value) ⇒ Object 



399
400
401
402
 
# File 'cloud_watch/cfn_alarm.rb', line 399

def extended_statistic=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "extendedStatistic") unless value.nil?
  jsii_set_property("extendedStatistic", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



756
757
758
759
760
 
# File 'cloud_watch/cfn_alarm.rb', line 756

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



767
768
769
770
 
# File 'cloud_watch/cfn_alarm.rb', line 767

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



837
838
839
840
 
# File 'cloud_watch/cfn_alarm.rb', line 837

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#insufficient_data_actions ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


407
408
409
 
# File 'cloud_watch/cfn_alarm.rb', line 407

def insufficient_data_actions()
  jsii_get_property("insufficientDataActions")
end

#insufficient_data_actions=(value) ⇒ Object 



411
412
413
414
 
# File 'cloud_watch/cfn_alarm.rb', line 411

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

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


159
160
161
 
# File 'cloud_watch/cfn_alarm.rb', line 159

def logical_id()
  jsii_get_property("logicalId")
end

#metric_name ⇒ String?

The name of the metric associated with the alarm.

Returns:

  • (String, nil) 


419
420
421
 
# File 'cloud_watch/cfn_alarm.rb', line 419

def metric_name()
  jsii_get_property("metricName")
end

#metric_name=(value) ⇒ Object 



423
424
425
426
 
# File 'cloud_watch/cfn_alarm.rb', line 423

def metric_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName") unless value.nil?
  jsii_set_property("metricName", value)
end

#metrics ⇒ AWSCDK::IResolvable, ...

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

Returns:



431
432
433
 
# File 'cloud_watch/cfn_alarm.rb', line 431

def metrics()
  jsii_get_property("metrics")
end

#metrics=(value) ⇒ Object 



435
436
437
438
 
# File 'cloud_watch/cfn_alarm.rb', line 435

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

#namespace ⇒ String?

The namespace of the metric associated with the alarm.

Returns:

  • (String, nil) 


443
444
445
 
# File 'cloud_watch/cfn_alarm.rb', line 443

def namespace()
  jsii_get_property("namespace")
end

#namespace=(value) ⇒ Object 



447
448
449
450
 
# File 'cloud_watch/cfn_alarm.rb', line 447

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



778
779
780
 
# File 'cloud_watch/cfn_alarm.rb', line 778

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



785
786
787
 
# File 'cloud_watch/cfn_alarm.rb', line 785

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#ok_actions ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


455
456
457
 
# File 'cloud_watch/cfn_alarm.rb', line 455

def ok_actions()
  jsii_get_property("okActions")
end

#ok_actions=(value) ⇒ Object 



459
460
461
462
 
# File 'cloud_watch/cfn_alarm.rb', line 459

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

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



578
579
580
581
 
# File 'cloud_watch/cfn_alarm.rb', line 578

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#period ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


467
468
469
 
# File 'cloud_watch/cfn_alarm.rb', line 467

def period()
  jsii_get_property("period")
end

#period=(value) ⇒ Object 



471
472
473
474
 
# File 'cloud_watch/cfn_alarm.rb', line 471

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

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


178
179
180
 
# File 'cloud_watch/cfn_alarm.rb', line 178

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



796
797
798
799
 
# File 'cloud_watch/cfn_alarm.rb', line 796

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


803
804
805
806
 
# File 'cloud_watch/cfn_alarm.rb', line 803

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



813
814
815
816
817
 
# File 'cloud_watch/cfn_alarm.rb', line 813

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



822
823
824
 
# File 'cloud_watch/cfn_alarm.rb', line 822

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



168
169
170
 
# File 'cloud_watch/cfn_alarm.rb', line 168

def stack()
  jsii_get_property("stack")
end

#statistic ⇒ String?

The statistic for the metric associated with the alarm, other than percentile.

For percentile statistics, use ExtendedStatistic .

Returns:

  • (String, nil) 


481
482
483
 
# File 'cloud_watch/cfn_alarm.rb', line 481

def statistic()
  jsii_get_property("statistic")
end

#statistic=(value) ⇒ Object 



485
486
487
488
 
# File 'cloud_watch/cfn_alarm.rb', line 485

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

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



493
494
495
 
# File 'cloud_watch/cfn_alarm.rb', line 493

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



497
498
499
500
501
 
# File 'cloud_watch/cfn_alarm.rb', line 497

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#threshold ⇒ Numeric?

The value to compare with the specified statistic.

Returns:

  • (Numeric, nil) 


506
507
508
 
# File 'cloud_watch/cfn_alarm.rb', line 506

def threshold()
  jsii_get_property("threshold")
end

#threshold=(value) ⇒ Object 



510
511
512
513
 
# File 'cloud_watch/cfn_alarm.rb', line 510

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

#threshold_metric_id ⇒ String?

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) 


518
519
520
 
# File 'cloud_watch/cfn_alarm.rb', line 518

def threshold_metric_id()
  jsii_get_property("thresholdMetricId")
end

#threshold_metric_id=(value) ⇒ Object 



522
523
524
525
 
# File 'cloud_watch/cfn_alarm.rb', line 522

def threshold_metric_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "thresholdMetricId") unless value.nil?
  jsii_set_property("thresholdMetricId", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



554
555
556
 
# File 'cloud_watch/cfn_alarm.rb', line 554

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

#treat_missing_data ⇒ String?

Sets how this alarm is to handle missing data points.

Returns:

  • (String, nil) 


530
531
532
 
# File 'cloud_watch/cfn_alarm.rb', line 530

def treat_missing_data()
  jsii_get_property("treatMissingData")
end

#treat_missing_data=(value) ⇒ Object 



534
535
536
537
 
# File 'cloud_watch/cfn_alarm.rb', line 534

def treat_missing_data=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "treatMissingData") unless value.nil?
  jsii_set_property("treatMissingData", value)
end

#unit ⇒ String?

The unit of the metric associated with the alarm.

Returns:

  • (String, nil) 


542
543
544
 
# File 'cloud_watch/cfn_alarm.rb', line 542

def unit()
  jsii_get_property("unit")
end

#unit=(value) ⇒ Object 



546
547
548
549
 
# File 'cloud_watch/cfn_alarm.rb', line 546

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


215
216
217
 
# File 'cloud_watch/cfn_alarm.rb', line 215

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


828
829
830
831
 
# File 'cloud_watch/cfn_alarm.rb', line 828

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


567
568
569
570
571
572
 
# File 'cloud_watch/cfn_alarm.rb', line 567

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