Class: AWSCDK::MediaLive::CfnSignalMap

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

Overview

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnSignalMap

Create a new AWS::MediaLive::SignalMap.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::MediaLive::CfnSignalMapProps) —

    Resource properties.



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

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

Class Method Details

.arn_for_signal_map(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'media_live/cfn_signal_map.rb', line 92

def self.arn_for_signal_map(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZWRpYWxpdmUuSVNpZ25hbE1hcFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnSignalMap", "arnForSignalMap", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


199
200
201
 
# File 'media_live/cfn_signal_map.rb', line 199

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

.is_cfn_signal_map(x) ⇒ Boolean

Checks whether the given object is a CfnSignalMap.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


101
102
103
104
 
# File 'media_live/cfn_signal_map.rb', line 101

def self.is_cfn_signal_map(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnSignalMap", "isCfnSignalMap", [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
86
87
88
 
# File 'media_live/cfn_signal_map.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_cloud_watch_alarm_template_group_ids => { kind: :property, name: "attrCloudWatchAlarmTemplateGroupIds", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_error_message => { kind: :property, name: "attrErrorMessage", is_optional: false },
    :attr_event_bridge_rule_template_group_ids => { kind: :property, name: "attrEventBridgeRuleTemplateGroupIds", is_optional: false },
    :attr_failed_media_resource_map => { kind: :property, name: "attrFailedMediaResourceMap", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_identifier => { kind: :property, name: "attrIdentifier", is_optional: false },
    :attr_last_discovered_at => { kind: :property, name: "attrLastDiscoveredAt", is_optional: false },
    :attr_last_successful_monitor_deployment => { kind: :property, name: "attrLastSuccessfulMonitorDeployment", is_optional: false },
    :attr_media_resource_map => { kind: :property, name: "attrMediaResourceMap", is_optional: false },
    :attr_modified_at => { kind: :property, name: "attrModifiedAt", is_optional: false },
    :attr_monitor_changes_pending_deployment => { kind: :property, name: "attrMonitorChangesPendingDeployment", is_optional: false },
    :attr_monitor_deployment => { kind: :property, name: "attrMonitorDeployment", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :signal_map_ref => { kind: :property, name: "signalMapRef", is_optional: false },
    :discovery_entry_point_arn => { kind: :property, name: "discoveryEntryPointArn", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :cloud_watch_alarm_template_group_identifiers => { kind: :property, name: "cloudWatchAlarmTemplateGroupIdentifiers", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :event_bridge_rule_template_group_identifiers => { kind: :property, name: "eventBridgeRuleTemplateGroupIdentifiers", is_optional: true },
    :force_rediscovery => { kind: :property, name: "forceRediscovery", 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.



440
441
442
443
 
# File 'media_live/cfn_signal_map.rb', line 440

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:



452
453
454
455
 
# File 'media_live/cfn_signal_map.rb', line 452

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:



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

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:



473
474
475
476
477
 
# File 'media_live/cfn_signal_map.rb', line 473

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.


530
531
532
533
534
 
# File 'media_live/cfn_signal_map.rb', line 530

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.



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

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.



552
553
554
555
556
 
# File 'media_live/cfn_signal_map.rb', line 552

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:



565
566
567
568
 
# File 'media_live/cfn_signal_map.rb', line 565

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:



587
588
589
590
591
592
 
# File 'media_live/cfn_signal_map.rb', line 587

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 signal map's ARN (Amazon Resource Name).

Returns:

  • (String) 


206
207
208
 
# File 'media_live/cfn_signal_map.rb', line 206

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_cloud_watch_alarm_template_group_ids ⇒ Array<String>

An alarm template group's id.

Returns:

  • (Array<String>) 


213
214
215
 
# File 'media_live/cfn_signal_map.rb', line 213

def attr_cloud_watch_alarm_template_group_ids()
  jsii_get_property("attrCloudWatchAlarmTemplateGroupIds")
end

#attr_created_at ⇒ String

The date and time of resource creation.

Returns:

  • (String) 


220
221
222
 
# File 'media_live/cfn_signal_map.rb', line 220

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_error_message ⇒ String

Error message associated with a failed creation or failed update attempt of a signal map.

Returns:

  • (String) 


227
228
229
 
# File 'media_live/cfn_signal_map.rb', line 227

def attr_error_message()
  jsii_get_property("attrErrorMessage")
end

#attr_event_bridge_rule_template_group_ids ⇒ Array<String>

An eventbridge rule template group's id.

Returns:

  • (Array<String>) 


234
235
236
 
# File 'media_live/cfn_signal_map.rb', line 234

def attr_event_bridge_rule_template_group_ids()
  jsii_get_property("attrEventBridgeRuleTemplateGroupIds")
end

#attr_failed_media_resource_map ⇒ AWSCDK::IResolvable

A map representing an incomplete AWS media workflow as a graph.

Returns:



241
242
243
 
# File 'media_live/cfn_signal_map.rb', line 241

def attr_failed_media_resource_map()
  jsii_get_property("attrFailedMediaResourceMap")
end

#attr_id ⇒ String

A signal map's id.

Returns:

  • (String) 


248
249
250
 
# File 'media_live/cfn_signal_map.rb', line 248

def attr_id()
  jsii_get_property("attrId")
end

#attr_identifier ⇒ String

Returns:

  • (String) 


253
254
255
 
# File 'media_live/cfn_signal_map.rb', line 253

def attr_identifier()
  jsii_get_property("attrIdentifier")
end

#attr_last_discovered_at ⇒ String

The date and time of latest discovery.

Returns:

  • (String) 


260
261
262
 
# File 'media_live/cfn_signal_map.rb', line 260

def attr_last_discovered_at()
  jsii_get_property("attrLastDiscoveredAt")
end

#attr_last_successful_monitor_deployment ⇒ AWSCDK::IResolvable

Represents the latest successful monitor deployment of a signal map.

Returns:



267
268
269
 
# File 'media_live/cfn_signal_map.rb', line 267

def attr_last_successful_monitor_deployment()
  jsii_get_property("attrLastSuccessfulMonitorDeployment")
end

#attr_media_resource_map ⇒ AWSCDK::IResolvable

A map representing an AWS media workflow as a graph.

Returns:



274
275
276
 
# File 'media_live/cfn_signal_map.rb', line 274

def attr_media_resource_map()
  jsii_get_property("attrMediaResourceMap")
end

#attr_modified_at ⇒ String

The date and time of latest resource modification.

Returns:

  • (String) 


281
282
283
 
# File 'media_live/cfn_signal_map.rb', line 281

def attr_modified_at()
  jsii_get_property("attrModifiedAt")
end

#attr_monitor_changes_pending_deployment ⇒ AWSCDK::IResolvable

If true, there are pending monitor changes for this signal map that can be deployed.

Returns:



288
289
290
 
# File 'media_live/cfn_signal_map.rb', line 288

def attr_monitor_changes_pending_deployment()
  jsii_get_property("attrMonitorChangesPendingDeployment")
end

#attr_monitor_deployment ⇒ AWSCDK::IResolvable

Represents the latest monitor deployment of a signal map.

Returns:



295
296
297
 
# File 'media_live/cfn_signal_map.rb', line 295

def attr_monitor_deployment()
  jsii_get_property("attrMonitorDeployment")
end

#attr_status ⇒ String

A signal map's current status, which is dependent on its lifecycle actions or associated jobs.

Returns:

  • (String) 


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

def attr_status()
  jsii_get_property("attrStatus")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



152
153
154
 
# File 'media_live/cfn_signal_map.rb', line 152

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


157
158
159
 
# File 'media_live/cfn_signal_map.rb', line 157

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


596
597
598
599
 
# File 'media_live/cfn_signal_map.rb', line 596

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


162
163
164
 
# File 'media_live/cfn_signal_map.rb', line 162

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


169
170
171
 
# File 'media_live/cfn_signal_map.rb', line 169

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cloud_watch_alarm_template_group_identifiers ⇒ Array<String>?

A cloudwatch alarm template group's identifier.

Returns:

  • (Array<String>, nil) 


347
348
349
 
# File 'media_live/cfn_signal_map.rb', line 347

def cloud_watch_alarm_template_group_identifiers()
  jsii_get_property("cloudWatchAlarmTemplateGroupIdentifiers")
end

#cloud_watch_alarm_template_group_identifiers=(value) ⇒ Object 



351
352
353
354
 
# File 'media_live/cfn_signal_map.rb', line 351

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


114
115
116
 
# File 'media_live/cfn_signal_map.rb', line 114

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A resource's optional description.

Returns:

  • (String, nil) 


359
360
361
 
# File 'media_live/cfn_signal_map.rb', line 359

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



363
364
365
366
 
# File 'media_live/cfn_signal_map.rb', line 363

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

#discovery_entry_point_arn ⇒ String

A top-level supported Amazon Web Services resource ARN to discover a signal map from.

Returns:

  • (String) 


323
324
325
 
# File 'media_live/cfn_signal_map.rb', line 323

def discovery_entry_point_arn()
  jsii_get_property("discoveryEntryPointArn")
end

#discovery_entry_point_arn=(value) ⇒ Object 



327
328
329
330
 
# File 'media_live/cfn_signal_map.rb', line 327

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



174
175
176
 
# File 'media_live/cfn_signal_map.rb', line 174

def env()
  jsii_get_property("env")
end

#event_bridge_rule_template_group_identifiers ⇒ Array<String>?

An eventbridge rule template group's identifier.

Returns:

  • (Array<String>, nil) 


371
372
373
 
# File 'media_live/cfn_signal_map.rb', line 371

def event_bridge_rule_template_group_identifiers()
  jsii_get_property("eventBridgeRuleTemplateGroupIdentifiers")
end

#event_bridge_rule_template_group_identifiers=(value) ⇒ Object 



375
376
377
378
 
# File 'media_live/cfn_signal_map.rb', line 375

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

#force_rediscovery ⇒ Boolean, ...

If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.

Returns:



383
384
385
 
# File 'media_live/cfn_signal_map.rb', line 383

def force_rediscovery()
  jsii_get_property("forceRediscovery")
end

#force_rediscovery=(value) ⇒ Object 



387
388
389
390
 
# File 'media_live/cfn_signal_map.rb', line 387

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



609
610
611
612
613
 
# File 'media_live/cfn_signal_map.rb', line 609

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:



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

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:



690
691
692
693
 
# File 'media_live/cfn_signal_map.rb', line 690

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) 


126
127
128
 
# File 'media_live/cfn_signal_map.rb', line 126

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A resource's name.

Returns:

  • (String) 


335
336
337
 
# File 'media_live/cfn_signal_map.rb', line 335

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



339
340
341
342
 
# File 'media_live/cfn_signal_map.rb', line 339

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) 


109
110
111
 
# File 'media_live/cfn_signal_map.rb', line 109

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:



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

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:



638
639
640
 
# File 'media_live/cfn_signal_map.rb', line 638

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.



431
432
433
434
 
# File 'media_live/cfn_signal_map.rb', line 431

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) 


145
146
147
 
# File 'media_live/cfn_signal_map.rb', line 145

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:



649
650
651
652
 
# File 'media_live/cfn_signal_map.rb', line 649

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


656
657
658
659
 
# File 'media_live/cfn_signal_map.rb', line 656

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:



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

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.



675
676
677
 
# File 'media_live/cfn_signal_map.rb', line 675

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

#signal_map_ref ⇒ AWSCDK::Interfaces::AWSMedialive::SignalMapReference

A reference to a SignalMap resource.

Returns:



316
317
318
 
# File 'media_live/cfn_signal_map.rb', line 316

def signal_map_ref()
  jsii_get_property("signalMapRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



135
136
137
 
# File 'media_live/cfn_signal_map.rb', line 135

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Hash{String => String}?

Represents the tags associated with a resource.

Returns:

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


395
396
397
 
# File 'media_live/cfn_signal_map.rb', line 395

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



399
400
401
402
 
# File 'media_live/cfn_signal_map.rb', line 399

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



407
408
409
 
# File 'media_live/cfn_signal_map.rb', line 407

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


182
183
184
 
# File 'media_live/cfn_signal_map.rb', line 182

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


192
193
194
 
# File 'media_live/cfn_signal_map.rb', line 192

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


681
682
683
684
 
# File 'media_live/cfn_signal_map.rb', line 681

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) 


420
421
422
423
424
425
 
# File 'media_live/cfn_signal_map.rb', line 420

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