Class: AWSCDK::MediaPackagev2::CfnOriginEndpointProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_packagev2/cfn_origin_endpoint_props.rb

Overview

Properties for defining a CfnOriginEndpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(channel_group_name:, channel_name:, container_type:, origin_endpoint_name:, dash_manifests: nil, description: nil, force_endpoint_error_configuration: nil, hls_manifests: nil, low_latency_hls_manifests: nil, mss_manifests: nil, segment: nil, startover_window_seconds: nil, tags: nil, uri_separator: nil) ⇒ CfnOriginEndpointProps

Returns a new instance of CfnOriginEndpointProps.

Parameters:



23
24
25
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
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 23

def initialize(channel_group_name:, channel_name:, container_type:, origin_endpoint_name:, dash_manifests: nil, description: nil, force_endpoint_error_configuration: nil, hls_manifests: nil, low_latency_hls_manifests: nil, mss_manifests: nil, segment: nil, startover_window_seconds: nil, tags: nil, uri_separator: nil)
  @channel_group_name = channel_group_name
  Jsii::Type.check_type(@channel_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelGroupName")
  @channel_name = channel_name
  Jsii::Type.check_type(@channel_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelName")
  @container_type = container_type
  Jsii::Type.check_type(@container_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "containerType")
  @origin_endpoint_name = origin_endpoint_name
  Jsii::Type.check_type(@origin_endpoint_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "originEndpointName")
  @dash_manifests = dash_manifests
  Jsii::Type.check_type(@dash_manifests, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFwYWNrYWdldjIuQ2ZuT3JpZ2luRW5kcG9pbnQuRGFzaE1hbmlmZXN0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "dashManifests") unless @dash_manifests.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @force_endpoint_error_configuration = force_endpoint_error_configuration.is_a?(Hash) ? ::AWSCDK::MediaPackagev2::CfnOriginEndpoint::ForceEndpointErrorConfigurationProperty.new(**force_endpoint_error_configuration.transform_keys(&:to_sym)) : force_endpoint_error_configuration
  Jsii::Type.check_type(@force_endpoint_error_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2V2Mi5DZm5PcmlnaW5FbmRwb2ludC5Gb3JjZUVuZHBvaW50RXJyb3JDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "forceEndpointErrorConfiguration") unless @force_endpoint_error_configuration.nil?
  @hls_manifests = hls_manifests
  Jsii::Type.check_type(@hls_manifests, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFwYWNrYWdldjIuQ2ZuT3JpZ2luRW5kcG9pbnQuSGxzTWFuaWZlc3RDb25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "hlsManifests") unless @hls_manifests.nil?
  @low_latency_hls_manifests = low_latency_hls_manifests
  Jsii::Type.check_type(@low_latency_hls_manifests, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFwYWNrYWdldjIuQ2ZuT3JpZ2luRW5kcG9pbnQuTG93TGF0ZW5jeUhsc01hbmlmZXN0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "lowLatencyHlsManifests") unless @low_latency_hls_manifests.nil?
  @mss_manifests = mss_manifests
  Jsii::Type.check_type(@mss_manifests, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFwYWNrYWdldjIuQ2ZuT3JpZ2luRW5kcG9pbnQuTXNzTWFuaWZlc3RDb25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "mssManifests") unless @mss_manifests.nil?
  @segment = segment.is_a?(Hash) ? ::AWSCDK::MediaPackagev2::CfnOriginEndpoint::SegmentProperty.new(**segment.transform_keys(&:to_sym)) : segment
  Jsii::Type.check_type(@segment, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2V2Mi5DZm5PcmlnaW5FbmRwb2ludC5TZWdtZW50UHJvcGVydHkifV19fQ==")), "segment") unless @segment.nil?
  @startover_window_seconds = startover_window_seconds
  Jsii::Type.check_type(@startover_window_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "startoverWindowSeconds") unless @startover_window_seconds.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?
  @uri_separator = uri_separator
  Jsii::Type.check_type(@uri_separator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "uriSeparator") unless @uri_separator.nil?
end

Instance Attribute Details

#channel_group_nameString (readonly)

The name of the channel group associated with the origin endpoint configuration.



58
59
60
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 58

def channel_group_name
  @channel_group_name
end

#channel_nameString (readonly)

The channel name associated with the origin endpoint.



63
64
65
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 63

def channel_name
  @channel_name
end

#container_typeString (readonly)

The container type associated with the origin endpoint configuration.



68
69
70
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 68

def container_type
  @container_type
end

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

A DASH manifest configuration.



78
79
80
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 78

def dash_manifests
  @dash_manifests
end

#descriptionString? (readonly)

The description associated with the origin endpoint.



83
84
85
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 83

def description
  @description
end

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

The failover settings for the endpoint.



88
89
90
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 88

def force_endpoint_error_configuration
  @force_endpoint_error_configuration
end

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

The HLS manifests associated with the origin endpoint configuration.



93
94
95
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 93

def hls_manifests
  @hls_manifests
end

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

The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.



98
99
100
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 98

def low_latency_hls_manifests
  @low_latency_hls_manifests
end

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

A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint.

Each configuration represents a different MSS streaming option available from this endpoint.



105
106
107
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 105

def mss_manifests
  @mss_manifests
end

#origin_endpoint_nameString (readonly)

The name of the origin endpoint associated with the origin endpoint configuration.



73
74
75
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 73

def origin_endpoint_name
  @origin_endpoint_name
end

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

The segment associated with the origin endpoint.



110
111
112
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 110

def segment
  @segment
end

#startover_window_secondsNumeric? (readonly)

The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.

Viewers can start-over or catch-up on content that falls within the window.



117
118
119
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 117

def startover_window_seconds
  @startover_window_seconds
end

#tagsArray<AWSCDK::CfnTag>? (readonly)

The tags associated with the origin endpoint.



122
123
124
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 122

def tags
  @tags
end

#uri_separatorString? (readonly)



125
126
127
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 125

def uri_separator
  @uri_separator
end

Class Method Details

.jsii_propertiesObject



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 127

def self.jsii_properties
  {
    :channel_group_name => "channelGroupName",
    :channel_name => "channelName",
    :container_type => "containerType",
    :origin_endpoint_name => "originEndpointName",
    :dash_manifests => "dashManifests",
    :description => "description",
    :force_endpoint_error_configuration => "forceEndpointErrorConfiguration",
    :hls_manifests => "hlsManifests",
    :low_latency_hls_manifests => "lowLatencyHlsManifests",
    :mss_manifests => "mssManifests",
    :segment => "segment",
    :startover_window_seconds => "startoverWindowSeconds",
    :tags => "tags",
    :uri_separator => "uriSeparator",
  }
end

Instance Method Details

#to_jsiiObject



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'media_packagev2/cfn_origin_endpoint_props.rb', line 146

def to_jsii
  result = {}
  result.merge!({
    "channelGroupName" => @channel_group_name,
    "channelName" => @channel_name,
    "containerType" => @container_type,
    "originEndpointName" => @origin_endpoint_name,
    "dashManifests" => @dash_manifests,
    "description" => @description,
    "forceEndpointErrorConfiguration" => @force_endpoint_error_configuration,
    "hlsManifests" => @hls_manifests,
    "lowLatencyHlsManifests" => @low_latency_hls_manifests,
    "mssManifests" => @mss_manifests,
    "segment" => @segment,
    "startoverWindowSeconds" => @startover_window_seconds,
    "tags" => @tags,
    "uriSeparator" => @uri_separator,
  })
  result.compact
end