Class: AWSCDK::MediaLive::CfnChannel

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSMedialive::IChannelRef
Defined in:
media_live/cfn_channel.rb

Overview

The AWS::MediaLive::Channel resource is a MediaLive resource type that creates a channel.

A MediaLive channel ingests and transcodes (decodes and encodes) source content from the inputs that are attached to that channel, and packages the new content into outputs.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::MediaLive::Channel.

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::CfnChannelProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'media_live/cfn_channel.rb', line 20

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

Class Method Details

.arn_for_channel(resource) ⇒ String

Parameters:

Returns:

  • (String) 


93
94
95
96
 
# File 'media_live/cfn_channel.rb', line 93

def self.arn_for_channel(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZWRpYWxpdmUuSUNoYW5uZWxSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnChannel", "arnForChannel", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


226
227
228
 
# File 'media_live/cfn_channel.rb', line 226

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

.from_channel_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSMedialive::IChannelRef

Creates a new IChannelRef from an ARN.

Parameters:

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

Returns:



104
105
106
107
108
109
 
# File 'media_live/cfn_channel.rb', line 104

def self.from_channel_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnChannel", "fromChannelArn", [scope, id, arn])
end

.from_channel_id(scope, id, channel_id) ⇒ AWSCDK::Interfaces::AWSMedialive::IChannelRef

Creates a new IChannelRef from a channelId.

Parameters:

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

Returns:



117
118
119
120
121
122
 
# File 'media_live/cfn_channel.rb', line 117

def self.from_channel_id(scope, id, channel_id)
  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(channel_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnChannel", "fromChannelId", [scope, id, channel_id])
end

.is_cfn_channel(x) ⇒ Boolean

Checks whether the given object is a CfnChannel.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


128
129
130
131
 
# File 'media_live/cfn_channel.rb', line 128

def self.is_cfn_channel(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnChannel", "isCfnChannel", [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
85
86
87
88
89
 
# File 'media_live/cfn_channel.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 },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_inputs => { kind: :property, name: "attrInputs", is_optional: false },
    :channel_ref => { kind: :property, name: "channelRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false },
    :anywhere_settings => { kind: :property, name: "anywhereSettings", is_optional: true },
    :cdi_input_specification => { kind: :property, name: "cdiInputSpecification", is_optional: true },
    :channel_class => { kind: :property, name: "channelClass", is_optional: true },
    :channel_engine_version => { kind: :property, name: "channelEngineVersion", is_optional: true },
    :channel_security_groups => { kind: :property, name: "channelSecurityGroups", is_optional: true },
    :destinations => { kind: :property, name: "destinations", is_optional: true },
    :dry_run => { kind: :property, name: "dryRun", is_optional: true },
    :encoder_settings => { kind: :property, name: "encoderSettings", is_optional: true },
    :inference_settings => { kind: :property, name: "inferenceSettings", is_optional: true },
    :input_attachments => { kind: :property, name: "inputAttachments", is_optional: true },
    :input_specification => { kind: :property, name: "inputSpecification", is_optional: true },
    :linked_channel_settings => { kind: :property, name: "linkedChannelSettings", is_optional: true },
    :log_level => { kind: :property, name: "logLevel", is_optional: true },
    :maintenance => { kind: :property, name: "maintenance", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :role_arn => { kind: :property, name: "roleArn", is_optional: true },
    :vpc => { kind: :property, name: "vpc", 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.



520
521
522
523
 
# File 'media_live/cfn_channel.rb', line 520

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:



532
533
534
535
 
# File 'media_live/cfn_channel.rb', line 532

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:



542
543
544
545
 
# File 'media_live/cfn_channel.rb', line 542

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:



553
554
555
556
557
 
# File 'media_live/cfn_channel.rb', line 553

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.


610
611
612
613
614
 
# File 'media_live/cfn_channel.rb', line 610

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.



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

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.



632
633
634
635
636
 
# File 'media_live/cfn_channel.rb', line 632

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

#anywhere_settings ⇒ AWSCDK::IResolvable, ...

Returns:



284
285
286
 
# File 'media_live/cfn_channel.rb', line 284

def anywhere_settings()
  jsii_get_property("anywhereSettings")
end

#anywhere_settings=(value) ⇒ Object 



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

def anywhere_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::AnywhereSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5Bbnl3aGVyZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "anywhereSettings") unless value.nil?
  jsii_set_property("anywhereSettings", 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:



645
646
647
648
 
# File 'media_live/cfn_channel.rb', line 645

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:



667
668
669
670
671
672
 
# File 'media_live/cfn_channel.rb', line 667

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 MediaLive channel.

For example: arn:aws:medialive:us-west-1:111122223333:medialive:channel:1234567

Returns:

  • (String) 


235
236
237
 
# File 'media_live/cfn_channel.rb', line 235

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_id ⇒ String

User-specified id.

This is used in an output group or an output.

Returns:

  • (String) 


244
245
246
 
# File 'media_live/cfn_channel.rb', line 244

def attr_id()
  jsii_get_property("attrId")
end

#attr_inputs ⇒ Array<String>

The inputs that are attached to this channel.

The inputs are identified by their IDs (not by their names or their ARNs).

Returns:

  • (Array<String>) 


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

def attr_inputs()
  jsii_get_property("attrInputs")
end

#cdi_input_specification ⇒ AWSCDK::IResolvable, ...

Specification of CDI inputs for this channel.

Returns:



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

def cdi_input_specification()
  jsii_get_property("cdiInputSpecification")
end

#cdi_input_specification=(value) ⇒ Object 



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

def cdi_input_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::CdiInputSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5DZGlJbnB1dFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "cdiInputSpecification") unless value.nil?
  jsii_set_property("cdiInputSpecification", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


184
185
186
 
# File 'media_live/cfn_channel.rb', line 184

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#channel_class ⇒ String?

The class for this channel.

Returns:

  • (String, nil) 


310
311
312
 
# File 'media_live/cfn_channel.rb', line 310

def channel_class()
  jsii_get_property("channelClass")
end

#channel_class=(value) ⇒ Object 



314
315
316
317
 
# File 'media_live/cfn_channel.rb', line 314

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

#channel_engine_version ⇒ AWSCDK::IResolvable, ...

Returns:



320
321
322
 
# File 'media_live/cfn_channel.rb', line 320

def channel_engine_version()
  jsii_get_property("channelEngineVersion")
end

#channel_engine_version=(value) ⇒ Object 



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

def channel_engine_version=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::ChannelEngineVersionRequestProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5DaGFubmVsRW5naW5lVmVyc2lvblJlcXVlc3RQcm9wZXJ0eSJ9XX19")), "channelEngineVersion") unless value.nil?
  jsii_set_property("channelEngineVersion", value)
end

#channel_ref ⇒ AWSCDK::Interfaces::AWSMedialive::ChannelReference

A reference to a Channel resource.

Returns:



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

def channel_ref()
  jsii_get_property("channelRef")
end

#channel_security_groups ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


331
332
333
 
# File 'media_live/cfn_channel.rb', line 331

def channel_security_groups()
  jsii_get_property("channelSecurityGroups")
end

#channel_security_groups=(value) ⇒ Object 



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

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


141
142
143
 
# File 'media_live/cfn_channel.rb', line 141

def creation_stack()
  jsii_get_property("creationStack")
end

#destinations ⇒ AWSCDK::IResolvable, ...

The settings that identify the destination for the outputs in this MediaLive output package.

Returns:



343
344
345
 
# File 'media_live/cfn_channel.rb', line 343

def destinations()
  jsii_get_property("destinations")
end

#destinations=(value) ⇒ Object 



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

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

#dry_run ⇒ Boolean, ...

Returns:



353
354
355
 
# File 'media_live/cfn_channel.rb', line 353

def dry_run()
  jsii_get_property("dryRun")
end

#dry_run=(value) ⇒ Object 



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

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

#encoder_settings ⇒ AWSCDK::IResolvable, ...

The encoding configuration for the output content.

Returns:



365
366
367
 
# File 'media_live/cfn_channel.rb', line 365

def encoder_settings()
  jsii_get_property("encoderSettings")
end

#encoder_settings=(value) ⇒ Object 



369
370
371
372
373
 
# File 'media_live/cfn_channel.rb', line 369

def encoder_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::EncoderSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5FbmNvZGVyU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "encoderSettings") unless value.nil?
  jsii_set_property("encoderSettings", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



201
202
203
 
# File 'media_live/cfn_channel.rb', line 201

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:



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

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:



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

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

#inference_settings ⇒ AWSCDK::IResolvable, ...

Returns:



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

def inference_settings()
  jsii_get_property("inferenceSettings")
end

#inference_settings=(value) ⇒ Object 



380
381
382
383
384
 
# File 'media_live/cfn_channel.rb', line 380

def inference_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::InferenceSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5JbmZlcmVuY2VTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "inferenceSettings") unless value.nil?
  jsii_set_property("inferenceSettings", value)
end

#input_attachments ⇒ AWSCDK::IResolvable, ...

The list of input attachments for the channel.

Returns:



389
390
391
 
# File 'media_live/cfn_channel.rb', line 389

def input_attachments()
  jsii_get_property("inputAttachments")
end

#input_attachments=(value) ⇒ Object 



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

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

#input_specification ⇒ AWSCDK::IResolvable, ...

The input specification for this channel.

Returns:



401
402
403
 
# File 'media_live/cfn_channel.rb', line 401

def input_specification()
  jsii_get_property("inputSpecification")
end

#input_specification=(value) ⇒ Object 



405
406
407
408
409
 
# File 'media_live/cfn_channel.rb', line 405

def input_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::InputSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5JbnB1dFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "inputSpecification") unless value.nil?
  jsii_set_property("inputSpecification", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



770
771
772
773
 
# File 'media_live/cfn_channel.rb', line 770

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

#linked_channel_settings ⇒ AWSCDK::IResolvable, ...

Returns:



412
413
414
 
# File 'media_live/cfn_channel.rb', line 412

def linked_channel_settings()
  jsii_get_property("linkedChannelSettings")
end

#linked_channel_settings=(value) ⇒ Object 



416
417
418
419
420
 
# File 'media_live/cfn_channel.rb', line 416

def linked_channel_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::LinkedChannelSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5MaW5rZWRDaGFubmVsU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "linkedChannelSettings") unless value.nil?
  jsii_set_property("linkedChannelSettings", value)
end

#log_level ⇒ String?

The verbosity for logging activity for this channel.

Returns:

  • (String, nil) 


425
426
427
 
# File 'media_live/cfn_channel.rb', line 425

def log_level()
  jsii_get_property("logLevel")
end

#log_level=(value) ⇒ Object 



429
430
431
432
 
# File 'media_live/cfn_channel.rb', line 429

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

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

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

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


153
154
155
 
# File 'media_live/cfn_channel.rb', line 153

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance ⇒ AWSCDK::IResolvable, ...

Maintenance settings for this channel.

Returns:



437
438
439
 
# File 'media_live/cfn_channel.rb', line 437

def maintenance()
  jsii_get_property("maintenance")
end

#maintenance=(value) ⇒ Object 



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

def maintenance=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::MaintenanceCreateSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5NYWludGVuYW5jZUNyZWF0ZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "maintenance") unless value.nil?
  jsii_set_property("maintenance", value)
end

#name ⇒ String?

Name of channel.

Returns:

  • (String, nil) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



454
455
456
457
 
# File 'media_live/cfn_channel.rb', line 454

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


136
137
138
 
# File 'media_live/cfn_channel.rb', line 136

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:



711
712
713
 
# File 'media_live/cfn_channel.rb', line 711

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:



718
719
720
 
# File 'media_live/cfn_channel.rb', line 718

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.



511
512
513
514
 
# File 'media_live/cfn_channel.rb', line 511

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) 


172
173
174
 
# File 'media_live/cfn_channel.rb', line 172

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:



729
730
731
732
 
# File 'media_live/cfn_channel.rb', line 729

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


736
737
738
739
 
# File 'media_live/cfn_channel.rb', line 736

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:



746
747
748
749
750
 
# File 'media_live/cfn_channel.rb', line 746

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

#role_arn ⇒ String?

The IAM role for MediaLive to assume when running this channel.

Returns:

  • (String, nil) 


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

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



466
467
468
469
 
# File 'media_live/cfn_channel.rb', line 466

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



755
756
757
 
# File 'media_live/cfn_channel.rb', line 755

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:



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

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Object

A collection of tags for this channel.

Returns:

  • (Object) 


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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



278
279
280
281
 
# File 'media_live/cfn_channel.rb', line 278

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tagsRaw")
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



487
488
489
 
# File 'media_live/cfn_channel.rb', line 487

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


209
210
211
 
# File 'media_live/cfn_channel.rb', line 209

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


761
762
763
764
 
# File 'media_live/cfn_channel.rb', line 761

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc ⇒ AWSCDK::IResolvable, ...

Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.

Returns:



474
475
476
 
# File 'media_live/cfn_channel.rb', line 474

def vpc()
  jsii_get_property("vpc")
end

#vpc=(value) ⇒ Object 



478
479
480
481
482
 
# File 'media_live/cfn_channel.rb', line 478

def vpc=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::VPCOutputSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5WcGNPdXRwdXRTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "vpc") unless value.nil?
  jsii_set_property("vpc", value)
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) 


500
501
502
503
504
505
 
# File 'media_live/cfn_channel.rb', line 500

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