Class: AWSCDK::MediaLive::CfnChannelProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel_props.rb

Overview

Properties for defining a CfnChannel.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(anywhere_settings: nil, cdi_input_specification: nil, channel_class: nil, channel_engine_version: nil, channel_security_groups: nil, destinations: nil, dry_run: nil, encoder_settings: nil, inference_settings: nil, input_attachments: nil, input_specification: nil, linked_channel_settings: nil, log_level: nil, maintenance: nil, name: nil, role_arn: nil, tags: nil, vpc: nil) ⇒ CfnChannelProps

Returns a new instance of CfnChannelProps.

Parameters:



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

def initialize(anywhere_settings: nil, cdi_input_specification: nil, channel_class: nil, channel_engine_version: nil, channel_security_groups: nil, destinations: nil, dry_run: nil, encoder_settings: nil, inference_settings: nil, input_attachments: nil, input_specification: nil, linked_channel_settings: nil, log_level: nil, maintenance: nil, name: nil, role_arn: nil, tags: nil, vpc: nil)
  @anywhere_settings = anywhere_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::AnywhereSettingsProperty.new(**anywhere_settings.transform_keys(&:to_sym)) : anywhere_settings
  Jsii::Type.check_type(@anywhere_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5Bbnl3aGVyZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "anywhereSettings") unless @anywhere_settings.nil?
  @cdi_input_specification = cdi_input_specification.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::CdiInputSpecificationProperty.new(**cdi_input_specification.transform_keys(&:to_sym)) : cdi_input_specification
  Jsii::Type.check_type(@cdi_input_specification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5DZGlJbnB1dFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "cdiInputSpecification") unless @cdi_input_specification.nil?
  @channel_class = channel_class
  Jsii::Type.check_type(@channel_class, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelClass") unless @channel_class.nil?
  @channel_engine_version = channel_engine_version.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::ChannelEngineVersionRequestProperty.new(**channel_engine_version.transform_keys(&:to_sym)) : channel_engine_version
  Jsii::Type.check_type(@channel_engine_version, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5DaGFubmVsRW5naW5lVmVyc2lvblJlcXVlc3RQcm9wZXJ0eSJ9XX19")), "channelEngineVersion") unless @channel_engine_version.nil?
  @channel_security_groups = channel_security_groups
  Jsii::Type.check_type(@channel_security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "channelSecurityGroups") unless @channel_security_groups.nil?
  @destinations = destinations
  Jsii::Type.check_type(@destinations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFsaXZlLkNmbkNoYW5uZWwuT3V0cHV0RGVzdGluYXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "destinations") unless @destinations.nil?
  @dry_run = dry_run
  Jsii::Type.check_type(@dry_run, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "dryRun") unless @dry_run.nil?
  @encoder_settings = encoder_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::EncoderSettingsProperty.new(**encoder_settings.transform_keys(&:to_sym)) : encoder_settings
  Jsii::Type.check_type(@encoder_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5FbmNvZGVyU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "encoderSettings") unless @encoder_settings.nil?
  @inference_settings = inference_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::InferenceSettingsProperty.new(**inference_settings.transform_keys(&:to_sym)) : inference_settings
  Jsii::Type.check_type(@inference_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5JbmZlcmVuY2VTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "inferenceSettings") unless @inference_settings.nil?
  @input_attachments = input_attachments
  Jsii::Type.check_type(@input_attachments, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFsaXZlLkNmbkNoYW5uZWwuSW5wdXRBdHRhY2htZW50UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "inputAttachments") unless @input_attachments.nil?
  @input_specification = input_specification.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::InputSpecificationProperty.new(**input_specification.transform_keys(&:to_sym)) : input_specification
  Jsii::Type.check_type(@input_specification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5JbnB1dFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "inputSpecification") unless @input_specification.nil?
  @linked_channel_settings = linked_channel_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::LinkedChannelSettingsProperty.new(**linked_channel_settings.transform_keys(&:to_sym)) : linked_channel_settings
  Jsii::Type.check_type(@linked_channel_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5MaW5rZWRDaGFubmVsU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "linkedChannelSettings") unless @linked_channel_settings.nil?
  @log_level = log_level
  Jsii::Type.check_type(@log_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logLevel") unless @log_level.nil?
  @maintenance = maintenance.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::MaintenanceCreateSettingsProperty.new(**maintenance.transform_keys(&:to_sym)) : maintenance
  Jsii::Type.check_type(@maintenance, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5NYWludGVuYW5jZUNyZWF0ZVNldHRpbmdzUHJvcGVydHkifV19fQ==")), "maintenance") unless @maintenance.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tags") unless @tags.nil?
  @vpc = vpc.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::VPCOutputSettingsProperty.new(**vpc.transform_keys(&:to_sym)) : vpc
  Jsii::Type.check_type(@vpc, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5WcGNPdXRwdXRTZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "vpc") unless @vpc.nil?
end

Instance Attribute Details

#anywhere_settingsAWSCDK::IResolvable, ... (readonly)



68
69
70
# File 'media_live/cfn_channel_props.rb', line 68

def anywhere_settings
  @anywhere_settings
end

#cdi_input_specificationAWSCDK::IResolvable, ... (readonly)

Specification of CDI inputs for this channel.



73
74
75
# File 'media_live/cfn_channel_props.rb', line 73

def cdi_input_specification
  @cdi_input_specification
end

#channel_classString? (readonly)

The class for this channel.

For a channel with two pipelines, the class is STANDARD. For a channel with one pipeline, the class is SINGLE_PIPELINE.



80
81
82
# File 'media_live/cfn_channel_props.rb', line 80

def channel_class
  @channel_class
end

#channel_engine_versionAWSCDK::IResolvable, ... (readonly)



83
84
85
# File 'media_live/cfn_channel_props.rb', line 83

def channel_engine_version
  @channel_engine_version
end

#channel_security_groupsArray<String>? (readonly)



86
87
88
# File 'media_live/cfn_channel_props.rb', line 86

def channel_security_groups
  @channel_security_groups
end

#destinationsAWSCDK::IResolvable, ... (readonly)

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



91
92
93
# File 'media_live/cfn_channel_props.rb', line 91

def destinations
  @destinations
end

#dry_runBoolean, ... (readonly)



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

def dry_run
  @dry_run
end

#encoder_settingsAWSCDK::IResolvable, ... (readonly)

The encoding configuration for the output content.



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

def encoder_settings
  @encoder_settings
end

#inference_settingsAWSCDK::IResolvable, ... (readonly)



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

def inference_settings
  @inference_settings
end

#input_attachmentsAWSCDK::IResolvable, ... (readonly)

The list of input attachments for the channel.



107
108
109
# File 'media_live/cfn_channel_props.rb', line 107

def input_attachments
  @input_attachments
end

#input_specificationAWSCDK::IResolvable, ... (readonly)

The input specification for this channel.

It specifies the key characteristics of the inputs for this channel: the maximum bitrate, the resolution, and the codec.



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

def input_specification
  @input_specification
end

#linked_channel_settingsAWSCDK::IResolvable, ... (readonly)



117
118
119
# File 'media_live/cfn_channel_props.rb', line 117

def linked_channel_settings
  @linked_channel_settings
end

#log_levelString? (readonly)

The verbosity for logging activity for this channel.

Charges for logging (which are generated through Amazon CloudWatch Logging) are higher for higher verbosities.



124
125
126
# File 'media_live/cfn_channel_props.rb', line 124

def log_level
  @log_level
end

#maintenanceAWSCDK::IResolvable, ... (readonly)

Maintenance settings for this channel.



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

def maintenance
  @maintenance
end

#nameString? (readonly)

Name of channel.



134
135
136
# File 'media_live/cfn_channel_props.rb', line 134

def name
  @name
end

#role_arnString? (readonly)

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

The role is identified by its ARN.



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

def role_arn
  @role_arn
end

#tagsObject? (readonly)

A collection of tags for this channel.

Each tag is a key-value pair.



148
149
150
# File 'media_live/cfn_channel_props.rb', line 148

def tags
  @tags
end

#vpcAWSCDK::IResolvable, ... (readonly)

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



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

def vpc
  @vpc
end

Class Method Details

.jsii_propertiesObject



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'media_live/cfn_channel_props.rb', line 155

def self.jsii_properties
  {
    :anywhere_settings => "anywhereSettings",
    :cdi_input_specification => "cdiInputSpecification",
    :channel_class => "channelClass",
    :channel_engine_version => "channelEngineVersion",
    :channel_security_groups => "channelSecurityGroups",
    :destinations => "destinations",
    :dry_run => "dryRun",
    :encoder_settings => "encoderSettings",
    :inference_settings => "inferenceSettings",
    :input_attachments => "inputAttachments",
    :input_specification => "inputSpecification",
    :linked_channel_settings => "linkedChannelSettings",
    :log_level => "logLevel",
    :maintenance => "maintenance",
    :name => "name",
    :role_arn => "roleArn",
    :tags => "tags",
    :vpc => "vpc",
  }
end

Instance Method Details

#to_jsiiObject



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'media_live/cfn_channel_props.rb', line 178

def to_jsii
  result = {}
  result.merge!({
    "anywhereSettings" => @anywhere_settings,
    "cdiInputSpecification" => @cdi_input_specification,
    "channelClass" => @channel_class,
    "channelEngineVersion" => @channel_engine_version,
    "channelSecurityGroups" => @channel_security_groups,
    "destinations" => @destinations,
    "dryRun" => @dry_run,
    "encoderSettings" => @encoder_settings,
    "inferenceSettings" => @inference_settings,
    "inputAttachments" => @input_attachments,
    "inputSpecification" => @input_specification,
    "linkedChannelSettings" => @linked_channel_settings,
    "logLevel" => @log_level,
    "maintenance" => @maintenance,
    "name" => @name,
    "roleArn" => @role_arn,
    "tags" => @tags,
    "vpc" => @vpc,
  })
  result.compact
end