Class: AWSCDK::CloudWatch::CfnCompositeAlarm

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

Overview

The AWS::CloudWatch::CompositeAlarm type creates or updates a composite alarm.

When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

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. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

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) ⇒ CfnCompositeAlarm

Create a new AWS::CloudWatch::CompositeAlarm.

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::CfnCompositeAlarmProps) —

    Resource properties.



28
29
30
31
32
33
34
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 28

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

Class Method Details

.arn_for_composite_alarm(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_composite_alarm(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbG91ZHdhdGNoLklDb21wb3NpdGVBbGFybVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudwatch.CfnCompositeAlarm", "arnForCompositeAlarm", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

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

Creates a new ICompositeAlarmRef from a alarmName.

Parameters:

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

Returns:



103
104
105
106
107
108
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 103

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.CfnCompositeAlarm", "fromAlarmName", [scope, id, alarm_name])
end

.from_composite_alarm_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSCloudwatch::ICompositeAlarmRef

Creates a new ICompositeAlarmRef from an ARN.

Parameters:

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

Returns:



116
117
118
119
120
121
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 116

def self.from_composite_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.CfnCompositeAlarm", "fromCompositeAlarmArn", [scope, id, arn])
end

.is_cfn_composite_alarm(x) ⇒ Boolean

Checks whether the given object is a CfnCompositeAlarm.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 36

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 },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :composite_alarm_ref => { kind: :property, name: "compositeAlarmRef", is_optional: false },
    :alarm_rule => { kind: :property, name: "alarmRule", is_optional: false },
    :actions_enabled => { kind: :property, name: "actionsEnabled", is_optional: true },
    :actions_suppressor => { kind: :property, name: "actionsSuppressor", is_optional: true },
    :actions_suppressor_extension_period => { kind: :property, name: "actionsSuppressorExtensionPeriod", is_optional: true },
    :actions_suppressor_wait_period => { kind: :property, name: "actionsSuppressorWaitPeriod", 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 },
    :insufficient_data_actions => { kind: :property, name: "insufficientDataActions", is_optional: true },
    :ok_actions => { kind: :property, name: "okActions", is_optional: true },
    :tags => { kind: :property, name: "tags", 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 of the composite alarm.

Returns:



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

def actions_enabled()
  jsii_get_property("actionsEnabled")
end

#actions_enabled=(value) ⇒ Object 



269
270
271
272
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 269

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

#actions_suppressor ⇒ String?

Actions will be suppressed if the suppressor alarm is in the ALARM state.

Returns:

  • (String, nil) 


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

def actions_suppressor()
  jsii_get_property("actionsSuppressor")
end

#actions_suppressor=(value) ⇒ Object 



281
282
283
284
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 281

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

#actions_suppressor_extension_period ⇒ Numeric?

The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.

Returns:

  • (Numeric, nil) 


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

def actions_suppressor_extension_period()
  jsii_get_property("actionsSuppressorExtensionPeriod")
end

#actions_suppressor_extension_period=(value) ⇒ Object 



293
294
295
296
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 293

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

#actions_suppressor_wait_period ⇒ Numeric?

The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.

Returns:

  • (Numeric, nil) 


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

def actions_suppressor_wait_period()
  jsii_get_property("actionsSuppressorWaitPeriod")
end

#actions_suppressor_wait_period=(value) ⇒ Object 



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

def actions_suppressor_wait_period=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "actionsSuppressorWaitPeriod") unless value.nil?
  jsii_set_property("actionsSuppressorWaitPeriod", 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.



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

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:



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

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:



441
442
443
444
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 441

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:



452
453
454
455
456
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 452

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.


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

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.



519
520
521
522
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 519

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.



531
532
533
534
535
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 531

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 actions to execute when this alarm transitions to the ALARM state from any other state.

Returns:

  • (Array<String>, nil) 


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

def alarm_actions()
  jsii_get_property("alarmActions")
end

#alarm_actions=(value) ⇒ Object 



317
318
319
320
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 317

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 for the composite alarm.

Returns:

  • (String, nil) 


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

def alarm_description()
  jsii_get_property("alarmDescription")
end

#alarm_description=(value) ⇒ Object 



329
330
331
332
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 329

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 for the composite alarm.

Returns:

  • (String, nil) 


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

def alarm_name()
  jsii_get_property("alarmName")
end

#alarm_name=(value) ⇒ Object 



341
342
343
344
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 341

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_rule ⇒ String

An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.

Returns:

  • (String) 


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

def alarm_rule()
  jsii_get_property("alarmRule")
end

#alarm_rule=(value) ⇒ Object 



257
258
259
260
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 257

def alarm_rule=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alarmRule")
  jsii_set_property("alarmRule", value)
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:



544
545
546
547
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 544

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:



566
567
568
569
570
571
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 566

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 composite alarm, such as arn:aws:cloudwatch:us-west-2:123456789012:alarm/CompositeAlarmName .

Returns:

  • (String) 


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

def attr_arn()
  jsii_get_property("attrArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


183
184
185
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 183

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


575
576
577
578
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 575

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}) 


188
189
190
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 188

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#composite_alarm_ref ⇒ AWSCDK::Interfaces::AWSCloudwatch::CompositeAlarmReference

A reference to a CompositeAlarm resource.

Returns:



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

def composite_alarm_ref()
  jsii_get_property("compositeAlarmRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



200
201
202
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 200

def env()
  jsii_get_property("env")
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:



588
589
590
591
592
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 588

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:



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

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:



669
670
671
672
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 669

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) 


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

def insufficient_data_actions()
  jsii_get_property("insufficientDataActions")
end

#insufficient_data_actions=(value) ⇒ Object 



353
354
355
356
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 353

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) 


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

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

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:



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

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:



617
618
619
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 617

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) 


361
362
363
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 361

def ok_actions()
  jsii_get_property("okActions")
end

#ok_actions=(value) ⇒ Object 



365
366
367
368
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 365

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.



410
411
412
413
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 410

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

#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) 


171
172
173
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 171

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:



628
629
630
631
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 628

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}) 


635
636
637
638
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 635

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:



645
646
647
648
649
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 645

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.



654
655
656
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 654

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:



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

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



377
378
379
380
381
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 377

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

def to_string()
  jsii_call_method("toString", [])
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}) 


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

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}) 


218
219
220
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 218

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


660
661
662
663
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 660

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) 


399
400
401
402
403
404
 
# File 'cloud_watch/cfn_composite_alarm.rb', line 399

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