Class: AWSCDK::MediaLive::CfnCloudWatchAlarmTemplate

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSMedialive::ICloudWatchAlarmTemplateRef
Defined in:
media_live/cfn_cloud_watch_alarm_template.rb

Overview

Definition of AWS::MediaLive::CloudWatchAlarmTemplate Resource Type.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCloudWatchAlarmTemplate

Create a new AWS::MediaLive::CloudWatchAlarmTemplate.

Parameters:



18
19
20
21
22
23
24
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 18

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

Class Method Details

.arn_for_cloud_watch_alarm_template(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 89

def self.arn_for_cloud_watch_alarm_template(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZWRpYWxpdmUuSUNsb3VkV2F0Y2hBbGFybVRlbXBsYXRlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnCloudWatchAlarmTemplate", "arnForCloudWatchAlarmTemplate", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 196

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

.is_cfn_cloud_watch_alarm_template(x) ⇒ Boolean

Checks whether the given object is a CfnCloudWatchAlarmTemplate.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 98

def self.is_cfn_cloud_watch_alarm_template(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnCloudWatchAlarmTemplate", "isCfnCloudWatchAlarmTemplate", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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
85
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 26

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 },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_group_id => { kind: :property, name: "attrGroupId", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_identifier => { kind: :property, name: "attrIdentifier", is_optional: false },
    :attr_modified_at => { kind: :property, name: "attrModifiedAt", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :cloud_watch_alarm_template_ref => { kind: :property, name: "cloudWatchAlarmTemplateRef", is_optional: false },
    :comparison_operator => { kind: :property, name: "comparisonOperator", is_optional: false },
    :evaluation_periods => { kind: :property, name: "evaluationPeriods", is_optional: false },
    :metric_name => { kind: :property, name: "metricName", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :period => { kind: :property, name: "period", is_optional: false },
    :statistic => { kind: :property, name: "statistic", is_optional: false },
    :target_resource_type => { kind: :property, name: "targetResourceType", is_optional: false },
    :threshold => { kind: :property, name: "threshold", is_optional: false },
    :treat_missing_data => { kind: :property, name: "treatMissingData", is_optional: false },
    :datapoints_to_alarm => { kind: :property, name: "datapointsToAlarm", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :group_identifier => { kind: :property, name: "groupIdentifier", 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

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



450
451
452
453
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 450

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:



462
463
464
465
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 462

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:



472
473
474
475
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 472

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:



483
484
485
486
487
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 483

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.


540
541
542
543
544
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 540

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.



550
551
552
553
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 550

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.



562
563
564
565
566
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 562

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

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



575
576
577
578
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 575

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:



597
598
599
600
601
602
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 597

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

A cloudwatch alarm template's ARN (Amazon Resource Name).

Returns:

  • (String) 


203
204
205
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 203

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_at ⇒ String

The date and time of resource creation.

Returns:

  • (String) 


210
211
212
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 210

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_group_id ⇒ String

A CloudWatch alarm template group's id.

Amazon Web Services provided template groups have ids that start with aws-

Returns:

  • (String) 


219
220
221
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 219

def attr_group_id()
  jsii_get_property("attrGroupId")
end

#attr_id ⇒ String

A cloudwatch alarm template's id.

Amazon Web Services provided templates have ids that start with aws-.

Returns:

  • (String) 


228
229
230
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 228

def attr_id()
  jsii_get_property("attrId")
end

#attr_identifier ⇒ String

Returns:

  • (String) 


233
234
235
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 233

def attr_identifier()
  jsii_get_property("attrIdentifier")
end

#attr_modified_at ⇒ String

The date and time of latest resource modification.

Returns:

  • (String) 


240
241
242
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 240

def attr_modified_at()
  jsii_get_property("attrModifiedAt")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



247
248
249
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 247

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



149
150
151
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


606
607
608
609
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 606

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


159
160
161
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cloud_watch_alarm_template_ref ⇒ AWSCDK::Interfaces::AWSMedialive::CloudWatchAlarmTemplateReference

A reference to a CloudWatchAlarmTemplate resource.

Returns:



254
255
256
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 254

def cloud_watch_alarm_template_ref()
  jsii_get_property("cloudWatchAlarmTemplateRef")
end

#comparison_operator ⇒ String

The comparison operator used to compare the specified statistic and the threshold.

Returns:

  • (String) 


261
262
263
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 261

def comparison_operator()
  jsii_get_property("comparisonOperator")
end

#comparison_operator=(value) ⇒ Object 



265
266
267
268
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 265

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


111
112
113
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#datapoints_to_alarm ⇒ Numeric?

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

Returns:

  • (Numeric, nil) 


369
370
371
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 369

def datapoints_to_alarm()
  jsii_get_property("datapointsToAlarm")
end

#datapoints_to_alarm=(value) ⇒ Object 



373
374
375
376
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 373

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

#description ⇒ String?

A resource's optional description.

Returns:

  • (String, nil) 


381
382
383
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 381

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



385
386
387
388
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 385

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 171

def env()
  jsii_get_property("env")
end

#evaluation_periods ⇒ Numeric

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

Returns:

  • (Numeric) 


273
274
275
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 273

def evaluation_periods()
  jsii_get_property("evaluationPeriods")
end

#evaluation_periods=(value) ⇒ Object 



277
278
279
280
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 277

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



619
620
621
622
623
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 619

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:



630
631
632
633
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 630

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

#group_identifier ⇒ String?

A cloudwatch alarm template group's identifier.

Returns:

  • (String, nil) 


393
394
395
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 393

def group_identifier()
  jsii_get_property("groupIdentifier")
end

#group_identifier=(value) ⇒ Object 



397
398
399
400
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 397

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



700
701
702
703
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 700

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


123
124
125
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#metric_name ⇒ String

The name of the metric associated with the alarm.

Returns:

  • (String) 


285
286
287
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 285

def metric_name()
  jsii_get_property("metricName")
end

#metric_name=(value) ⇒ Object 



289
290
291
292
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 289

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

#name ⇒ String

A resource's name.

Returns:

  • (String) 


297
298
299
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 297

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



301
302
303
304
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 301

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 106

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:



641
642
643
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 641

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:



648
649
650
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 648

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
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.



441
442
443
444
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 441

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 specified statistic is applied.

Returns:

  • (Numeric) 


309
310
311
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 309

def period()
  jsii_get_property("period")
end

#period=(value) ⇒ Object 



313
314
315
316
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 313

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


142
143
144
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 142

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:



659
660
661
662
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 659

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


666
667
668
669
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 666

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:



676
677
678
679
680
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 676

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.



685
686
687
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 685

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:



132
133
134
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 132

def stack()
  jsii_get_property("stack")
end

#statistic ⇒ String

The statistic to apply to the alarm's metric data.

Returns:

  • (String) 


321
322
323
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 321

def statistic()
  jsii_get_property("statistic")
end

#statistic=(value) ⇒ Object 



325
326
327
328
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 325

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

#tags ⇒ Hash{String => String}?

Represents the tags associated with a resource.

Returns:

  • (Hash{String => String}, nil) 


405
406
407
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 405

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



409
410
411
412
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 409

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

#target_resource_type ⇒ String

The resource type this template should dynamically generate CloudWatch metric alarms for.

Returns:

  • (String) 


333
334
335
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 333

def target_resource_type()
  jsii_get_property("targetResourceType")
end

#target_resource_type=(value) ⇒ Object 



337
338
339
340
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 337

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

#threshold ⇒ Numeric

The threshold value to compare with the specified statistic.

Returns:

  • (Numeric) 


345
346
347
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 345

def threshold()
  jsii_get_property("threshold")
end

#threshold=(value) ⇒ Object 



349
350
351
352
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 349

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



417
418
419
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 417

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

#treat_missing_data ⇒ String

Specifies how missing data points are treated when evaluating the alarm's condition.

Returns:

  • (String) 


357
358
359
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 357

def treat_missing_data()
  jsii_get_property("treatMissingData")
end

#treat_missing_data=(value) ⇒ Object 



361
362
363
364
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 361

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


179
180
181
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 179

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


189
190
191
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


691
692
693
694
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 691

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) 


430
431
432
433
434
435
 
# File 'media_live/cfn_cloud_watch_alarm_template.rb', line 430

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