Class: AWSCDK::IVS::CfnChannelProps

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

Overview

Properties for defining a CfnChannel.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authorized: nil, container_format: nil, insecure_ingest: nil, latency_mode: nil, multitrack_input_configuration: nil, name: nil, preset: nil, recording_configuration_arn: nil, tags: nil, type: nil) ⇒ CfnChannelProps

Returns a new instance of CfnChannelProps.

Parameters:

  • authorized (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether the channel is authorized.

  • container_format (String, nil) (defaults to: nil) —

    Indicates which content-packaging format is used (MPEG-TS or fMP4).

  • insecure_ingest (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether the channel allows insecure RTMP ingest.

  • latency_mode (String, nil) (defaults to: nil) —

    Channel latency mode. Valid values:.

  • multitrack_input_configuration (AWSCDK::IResolvable, AWSCDK::IVS::CfnChannel::MultitrackInputConfigurationProperty, nil) (defaults to: nil) —

    Object specifying multitrack input configuration.

  • name (String, nil) (defaults to: nil) —

    Channel name.

  • preset (String, nil) (defaults to: nil) —

    An optional transcode preset for the channel.

  • recording_configuration_arn (String, AWSCDK::Interfaces::AWSIVS::IRecordingConfigurationRef, nil) (defaults to: nil) —

    The ARN of a RecordingConfiguration resource.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.

  • type (String, nil) (defaults to: nil) —

    The channel type, which determines the allowable resolution and bitrate.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'ivs/cfn_channel_props.rb', line 19

def initialize(authorized: nil, container_format: nil, insecure_ingest: nil, latency_mode: nil, multitrack_input_configuration: nil, name: nil, preset: nil, recording_configuration_arn: nil, tags: nil, type: nil)
  @authorized = authorized
  Jsii::Type.check_type(@authorized, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "authorized") unless @authorized.nil?
  @container_format = container_format
  Jsii::Type.check_type(@container_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "containerFormat") unless @container_format.nil?
  @insecure_ingest = insecure_ingest
  Jsii::Type.check_type(@insecure_ingest, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "insecureIngest") unless @insecure_ingest.nil?
  @latency_mode = latency_mode
  Jsii::Type.check_type(@latency_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "latencyMode") unless @latency_mode.nil?
  @multitrack_input_configuration = multitrack_input_configuration.is_a?(Hash) ? ::AWSCDK::IVS::CfnChannel::MultitrackInputConfigurationProperty.new(**multitrack_input_configuration.transform_keys(&:to_sym)) : multitrack_input_configuration
  Jsii::Type.check_type(@multitrack_input_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pdnMuQ2ZuQ2hhbm5lbC5NdWx0aXRyYWNrSW5wdXRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "multitrackInputConfiguration") unless @multitrack_input_configuration.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @preset = preset
  Jsii::Type.check_type(@preset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preset") unless @preset.nil?
  @recording_configuration_arn = recording_configuration_arn
  Jsii::Type.check_type(@recording_configuration_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pdnMuSVJlY29yZGluZ0NvbmZpZ3VyYXRpb25SZWYifV19fQ==")), "recordingConfigurationArn") unless @recording_configuration_arn.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#authorized ⇒ Boolean, ... (readonly)

Note:

Default: - false

Whether the channel is authorized.

Default : false

Returns:

See Also:



49
50
51
 
# File 'ivs/cfn_channel_props.rb', line 49

def authorized
  @authorized
end

#container_format ⇒ String? (readonly)

Note:

Default: - "TS"

Indicates which content-packaging format is used (MPEG-TS or fMP4).

If multitrack_input_configuration is specified and enabled is true , then container_format is required and must be set to FRAGMENTED_MP4 . Otherwise, container_format may be set to TS or FRAGMENTED_MP4 . Default: TS .

Returns:

  • (String, nil)

See Also:



57
58
59
 
# File 'ivs/cfn_channel_props.rb', line 57

def container_format
  @container_format
end

#insecure_ingest ⇒ Boolean, ... (readonly)

Note:

Default: - false

Whether the channel allows insecure RTMP ingest.

Default : false

Returns:

See Also:



65
66
67
 
# File 'ivs/cfn_channel_props.rb', line 65

def insecure_ingest
  @insecure_ingest
end

#latency_mode ⇒ String? (readonly)

Note:

Default: - "LOW"

Channel latency mode. Valid values:.

  • NORMAL : Use NORMAL to broadcast and deliver live video up to Full HD.
  • LOW : Use LOW for near real-time interactions with viewers.

In the console, LOW and NORMAL correspond to Ultra-low and Standard , respectively.

Default : LOW

Returns:

  • (String, nil)

See Also:



78
79
80
 
# File 'ivs/cfn_channel_props.rb', line 78

def latency_mode
  @latency_mode
end

#multitrack_input_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Object specifying multitrack input configuration.

Default: no multitrack input configuration is specified.

Returns:

See Also:



85
86
87
 
# File 'ivs/cfn_channel_props.rb', line 85

def multitrack_input_configuration
  @multitrack_input_configuration
end

#name ⇒ String? (readonly)

Note:

Default: - "-"

Channel name.

Returns:

  • (String, nil)

See Also:



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

def name
  @name
end

#preset ⇒ String? (readonly)

An optional transcode preset for the channel.

This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY . For other channel types ( BASIC and STANDARD ), preset is the empty string ("").

Returns:

  • (String, nil)

See Also:



98
99
100
 
# File 'ivs/cfn_channel_props.rb', line 98

def preset
  @preset
end

#recording_configuration_arn ⇒ String, ... (readonly)

Note:

Default: - ""

The ARN of a RecordingConfiguration resource.

An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the RecordingConfiguration resource for more information and an example.

Default : "" (empty string, recording is disabled)

Returns:

See Also:



108
109
110
 
# File 'ivs/cfn_channel_props.rb', line 108

def recording_configuration_arn
  @recording_configuration_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

See Also:



115
116
117
 
# File 'ivs/cfn_channel_props.rb', line 115

def tags
  @tags
end

#type ⇒ String? (readonly)

Note:

Default: - "STANDARD"

The channel type, which determines the allowable resolution and bitrate.

If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. For details, see Channel Types .

Default : STANDARD

Returns:

  • (String, nil)

See Also:



125
126
127
 
# File 'ivs/cfn_channel_props.rb', line 125

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'ivs/cfn_channel_props.rb', line 127

def self.jsii_properties
  {
    :authorized => "authorized",
    :container_format => "containerFormat",
    :insecure_ingest => "insecureIngest",
    :latency_mode => "latencyMode",
    :multitrack_input_configuration => "multitrackInputConfiguration",
    :name => "name",
    :preset => "preset",
    :recording_configuration_arn => "recordingConfigurationArn",
    :tags => "tags",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'ivs/cfn_channel_props.rb', line 142

def to_jsii
  result = {}
  result.merge!({
    "authorized" => @authorized,
    "containerFormat" => @container_format,
    "insecureIngest" => @insecure_ingest,
    "latencyMode" => @latency_mode,
    "multitrackInputConfiguration" => @multitrack_input_configuration,
    "name" => @name,
    "preset" => @preset,
    "recordingConfigurationArn" => @recording_configuration_arn,
    "tags" => @tags,
    "type" => @type,
  })
  result.compact
end