Class: AWSCDK::CloudWatch::CfnLogAlarm

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

Overview

Resource Type definition for AWS::CloudWatch::LogAlarm.

A LogAlarm evaluates scheduled query results from CloudWatch Logs and triggers actions when thresholds are breached.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnLogAlarm

Create a new AWS::CloudWatch::LogAlarm.

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

    Resource properties.



20
21
22
23
24
25
26
 
# File 'cloud_watch/cfn_log_alarm.rb', line 20

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

Class Method Details

.arn_for_log_alarm(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_log_alarm(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbG91ZHdhdGNoLklMb2dBbGFybVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudwatch.CfnLogAlarm", "arnForLogAlarm", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_log_alarm(x) ⇒ Boolean

Checks whether the given object is a CfnLogAlarm.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'cloud_watch/cfn_log_alarm.rb', line 97

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

.jsii_overridable_methods ⇒ Object 



28
29
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
 
# File 'cloud_watch/cfn_log_alarm.rb', line 28

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 },
    :log_alarm_ref => { kind: :property, name: "logAlarmRef", is_optional: false },
    :comparison_operator => { kind: :property, name: "comparisonOperator", is_optional: false },
    :query_results_to_alarm => { kind: :property, name: "queryResultsToAlarm", is_optional: false },
    :query_results_to_evaluate => { kind: :property, name: "queryResultsToEvaluate", is_optional: false },
    :scheduled_query_configuration => { kind: :property, name: "scheduledQueryConfiguration", is_optional: false },
    :threshold => { kind: :property, name: "threshold", is_optional: false },
    :action_log_line_count => { kind: :property, name: "actionLogLineCount", is_optional: true },
    :action_log_line_role_arn => { kind: :property, name: "actionLogLineRoleArn", is_optional: true },
    :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 },
    :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 },
    :treat_missing_data => { kind: :property, name: "treatMissingData", 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

#action_log_line_count ⇒ Numeric?

The number of log lines to include in alarm notifications.

Returns:

  • (Numeric, nil) 


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

def action_log_line_count()
  jsii_get_property("actionLogLineCount")
end

#action_log_line_count=(value) ⇒ Object 



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

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

#action_log_line_role_arn ⇒ String?

The ARN of the IAM role that grants CloudWatch permissions to fetch log lines for alarm notifications.

Returns:

  • (String, nil) 


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

def action_log_line_role_arn()
  jsii_get_property("actionLogLineRoleArn")
end

#action_log_line_role_arn=(value) ⇒ Object 



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

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

#actions_enabled ⇒ Boolean, ...

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

Returns:



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

def actions_enabled()
  jsii_get_property("actionsEnabled")
end

#actions_enabled=(value) ⇒ Object 



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

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.



438
439
440
441
 
# File 'cloud_watch/cfn_log_alarm.rb', line 438

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:



450
451
452
453
 
# File 'cloud_watch/cfn_log_alarm.rb', line 450

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:



460
461
462
463
 
# File 'cloud_watch/cfn_log_alarm.rb', line 460

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:



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

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.


528
529
530
531
532
 
# File 'cloud_watch/cfn_log_alarm.rb', line 528

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.



538
539
540
541
 
# File 'cloud_watch/cfn_log_alarm.rb', line 538

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.



550
551
552
553
554
 
# File 'cloud_watch/cfn_log_alarm.rb', line 550

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) 


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

def alarm_actions()
  jsii_get_property("alarmActions")
end

#alarm_actions=(value) ⇒ Object 



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

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 log alarm.

Returns:

  • (String, nil) 


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

def alarm_description()
  jsii_get_property("alarmDescription")
end

#alarm_description=(value) ⇒ Object 



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

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 log alarm.

Returns:

  • (String, nil) 


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

def alarm_name()
  jsii_get_property("alarmName")
end

#alarm_name=(value) ⇒ Object 



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

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

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



563
564
565
566
 
# File 'cloud_watch/cfn_log_alarm.rb', line 563

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:



585
586
587
588
589
590
 
# File 'cloud_watch/cfn_log_alarm.rb', line 585

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 log alarm.

Returns:

  • (String) 


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

def attr_arn()
  jsii_get_property("attrArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


594
595
596
597
 
# File 'cloud_watch/cfn_log_alarm.rb', line 594

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'cloud_watch/cfn_log_alarm.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#comparison_operator ⇒ String

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

Returns:

  • (String) 


223
224
225
 
# File 'cloud_watch/cfn_log_alarm.rb', line 223

def comparison_operator()
  jsii_get_property("comparisonOperator")
end

#comparison_operator=(value) ⇒ Object 



227
228
229
230
 
# File 'cloud_watch/cfn_log_alarm.rb', line 227

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

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:



607
608
609
610
611
 
# File 'cloud_watch/cfn_log_alarm.rb', line 607

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:



618
619
620
621
 
# File 'cloud_watch/cfn_log_alarm.rb', line 618

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:



688
689
690
691
 
# File 'cloud_watch/cfn_log_alarm.rb', line 688

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) 


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

def insufficient_data_actions()
  jsii_get_property("insufficientDataActions")
end

#insufficient_data_actions=(value) ⇒ Object 



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

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

#log_alarm_ref ⇒ AWSCDK::Interfaces::AWSCloudwatch::LogAlarmReference

A reference to a LogAlarm resource.

Returns:



216
217
218
 
# File 'cloud_watch/cfn_log_alarm.rb', line 216

def log_alarm_ref()
  jsii_get_property("logAlarmRef")
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) 


122
123
124
 
# File 'cloud_watch/cfn_log_alarm.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

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:



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

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:



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

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) 


368
369
370
 
# File 'cloud_watch/cfn_log_alarm.rb', line 368

def ok_actions()
  jsii_get_property("okActions")
end

#ok_actions=(value) ⇒ Object 



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

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.



429
430
431
432
 
# File 'cloud_watch/cfn_log_alarm.rb', line 429

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

#query_results_to_alarm ⇒ Numeric

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

Returns:

  • (Numeric) 


235
236
237
 
# File 'cloud_watch/cfn_log_alarm.rb', line 235

def query_results_to_alarm()
  jsii_get_property("queryResultsToAlarm")
end

#query_results_to_alarm=(value) ⇒ Object 



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

def query_results_to_alarm=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "queryResultsToAlarm")
  jsii_set_property("queryResultsToAlarm", value)
end

#query_results_to_evaluate ⇒ Numeric

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

Returns:

  • (Numeric) 


247
248
249
 
# File 'cloud_watch/cfn_log_alarm.rb', line 247

def query_results_to_evaluate()
  jsii_get_property("queryResultsToEvaluate")
end

#query_results_to_evaluate=(value) ⇒ Object 



251
252
253
254
 
# File 'cloud_watch/cfn_log_alarm.rb', line 251

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


141
142
143
 
# File 'cloud_watch/cfn_log_alarm.rb', line 141

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:



647
648
649
650
 
# File 'cloud_watch/cfn_log_alarm.rb', line 647

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


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

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:



664
665
666
667
668
 
# File 'cloud_watch/cfn_log_alarm.rb', line 664

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

#scheduled_query_configuration ⇒ AWSCDK::IResolvable, AWSCDK::CloudWatch::CfnLogAlarm::ScheduledQueryConfigurationProperty

The scheduled query configuration for the log alarm.

Returns:



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

def scheduled_query_configuration()
  jsii_get_property("scheduledQueryConfiguration")
end

#scheduled_query_configuration=(value) ⇒ Object 



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

def scheduled_query_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CloudWatch::CfnLogAlarm::ScheduledQueryConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZHdhdGNoLkNmbkxvZ0FsYXJtLlNjaGVkdWxlZFF1ZXJ5Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "scheduledQueryConfiguration")
  jsii_set_property("scheduledQueryConfiguration", value)
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.



673
674
675
 
# File 'cloud_watch/cfn_log_alarm.rb', line 673

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:



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

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



380
381
382
 
# File 'cloud_watch/cfn_log_alarm.rb', line 380

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



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

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 against the results of the scheduled query evaluation.

Returns:

  • (Numeric) 


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

def threshold()
  jsii_get_property("threshold")
end

#threshold=(value) ⇒ Object 



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

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



405
406
407
 
# File 'cloud_watch/cfn_log_alarm.rb', line 405

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) 


393
394
395
 
# File 'cloud_watch/cfn_log_alarm.rb', line 393

def treat_missing_data()
  jsii_get_property("treatMissingData")
end

#treat_missing_data=(value) ⇒ Object 



397
398
399
400
 
# File 'cloud_watch/cfn_log_alarm.rb', line 397

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

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


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

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


679
680
681
682
 
# File 'cloud_watch/cfn_log_alarm.rb', line 679

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) 


418
419
420
421
422
423
 
# File 'cloud_watch/cfn_log_alarm.rb', line 418

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