Class: AWSCDK::MediaPackagev2::CfnOriginEndpoint::HlsManifestConfigurationProperty

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

Overview

The HLS manifest configuration associated with the origin endpoint.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(manifest_name:, child_manifest_name: nil, filter_configuration: nil, manifest_window_seconds: nil, program_date_time_interval_seconds: nil, scte_hls: nil, start_tag: nil, uri_path_type: nil, url: nil, url_encode_child_manifest: nil) ⇒ HlsManifestConfigurationProperty

Returns a new instance of HlsManifestConfigurationProperty.

Parameters:

  • manifest_name (String) —

    The name of the manifest associated with the HLS manifest configuration.

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

    The name of the child manifest associated with the HLS manifest configuration.

  • filter_configuration (AWSCDK::IResolvable, AWSCDK::MediaPackagev2::CfnOriginEndpoint::FilterConfigurationProperty, nil) (defaults to: nil) —

    Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

  • manifest_window_seconds (Numeric, nil) (defaults to: nil) —

    The duration of the manifest window, in seconds, for the HLS manifest configuration.

  • program_date_time_interval_seconds (Numeric, nil) (defaults to: nil) —

    The EXT-X-PROGRAM-DATE-TIME interval, in seconds, associated with the HLS manifest configuration.

  • scte_hls (AWSCDK::IResolvable, AWSCDK::MediaPackagev2::CfnOriginEndpoint::ScteHlsProperty, nil) (defaults to: nil) —

    THE SCTE-35 HLS configuration associated with the HLS manifest configuration.

  • start_tag (AWSCDK::IResolvable, AWSCDK::MediaPackagev2::CfnOriginEndpoint::StartTagProperty, nil) (defaults to: nil) —

    To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset.

  • uri_path_type (String, nil) (defaults to: nil)
  • url (String, nil) (defaults to: nil) —

    The URL of the HLS manifest configuration.

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

    When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol.



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1747

def initialize(manifest_name:, child_manifest_name: nil, filter_configuration: nil, manifest_window_seconds: nil, program_date_time_interval_seconds: nil, scte_hls: nil, start_tag: nil, uri_path_type: nil, url: nil, url_encode_child_manifest: nil)
  @manifest_name = manifest_name
  Jsii::Type.check_type(@manifest_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "manifestName")
  @child_manifest_name = child_manifest_name
  Jsii::Type.check_type(@child_manifest_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "childManifestName") unless @child_manifest_name.nil?
  @filter_configuration = filter_configuration.is_a?(Hash) ? ::AWSCDK::MediaPackagev2::CfnOriginEndpoint::FilterConfigurationProperty.new(**filter_configuration.transform_keys(&:to_sym)) : filter_configuration
  Jsii::Type.check_type(@filter_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2V2Mi5DZm5PcmlnaW5FbmRwb2ludC5GaWx0ZXJDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "filterConfiguration") unless @filter_configuration.nil?
  @manifest_window_seconds = manifest_window_seconds
  Jsii::Type.check_type(@manifest_window_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "manifestWindowSeconds") unless @manifest_window_seconds.nil?
  @program_date_time_interval_seconds = program_date_time_interval_seconds
  Jsii::Type.check_type(@program_date_time_interval_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "programDateTimeIntervalSeconds") unless @program_date_time_interval_seconds.nil?
  @scte_hls = scte_hls.is_a?(Hash) ? ::AWSCDK::MediaPackagev2::CfnOriginEndpoint::ScteHlsProperty.new(**scte_hls.transform_keys(&:to_sym)) : scte_hls
  Jsii::Type.check_type(@scte_hls, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2V2Mi5DZm5PcmlnaW5FbmRwb2ludC5TY3RlSGxzUHJvcGVydHkifV19fQ==")), "scteHls") unless @scte_hls.nil?
  @start_tag = start_tag.is_a?(Hash) ? ::AWSCDK::MediaPackagev2::CfnOriginEndpoint::StartTagProperty.new(**start_tag.transform_keys(&:to_sym)) : start_tag
  Jsii::Type.check_type(@start_tag, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYXBhY2thZ2V2Mi5DZm5PcmlnaW5FbmRwb2ludC5TdGFydFRhZ1Byb3BlcnR5In1dfX0=")), "startTag") unless @start_tag.nil?
  @uri_path_type = uri_path_type
  Jsii::Type.check_type(@uri_path_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "uriPathType") unless @uri_path_type.nil?
  @url = url
  Jsii::Type.check_type(@url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "url") unless @url.nil?
  @url_encode_child_manifest = url_encode_child_manifest
  Jsii::Type.check_type(@url_encode_child_manifest, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "urlEncodeChildManifest") unless @url_encode_child_manifest.nil?
end

Instance Attribute Details

#child_manifest_name ⇒ String? (readonly)

The name of the child manifest associated with the HLS manifest configuration.

Returns:

  • (String, nil)

See Also:



1779
1780
1781
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1779

def child_manifest_name
  @child_manifest_name
end

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

Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

Returns:

See Also:



1784
1785
1786
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1784

def filter_configuration
  @filter_configuration
end

#manifest_name ⇒ String (readonly)

The name of the manifest associated with the HLS manifest configuration.

Returns:

  • (String)

See Also:



1774
1775
1776
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1774

def manifest_name
  @manifest_name
end

#manifest_window_seconds ⇒ Numeric? (readonly)

The duration of the manifest window, in seconds, for the HLS manifest configuration.

Returns:

  • (Numeric, nil)

See Also:



1789
1790
1791
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1789

def manifest_window_seconds
  @manifest_window_seconds
end

#program_date_time_interval_seconds ⇒ Numeric? (readonly)

The EXT-X-PROGRAM-DATE-TIME interval, in seconds, associated with the HLS manifest configuration.

Returns:

  • (Numeric, nil)

See Also:



1794
1795
1796
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1794

def program_date_time_interval_seconds
  @program_date_time_interval_seconds
end

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

THE SCTE-35 HLS configuration associated with the HLS manifest configuration.

Returns:

See Also:



1799
1800
1801
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1799

def scte_hls
  @scte_hls
end

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

To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset.

When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.

Returns:

See Also:



1806
1807
1808
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1806

def start_tag
  @start_tag
end

#uri_path_type ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



1809
1810
1811
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1809

def uri_path_type
  @uri_path_type
end

#url ⇒ String? (readonly)

The URL of the HLS manifest configuration.

Returns:

  • (String, nil)

See Also:



1814
1815
1816
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1814

def url
  @url
end

#url_encode_child_manifest ⇒ Boolean, ... (readonly)

When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with AWS Signature Version 4 (SigV4) signature signing protocol.

For more information, see AWS Signature Version 4 for API requests in AWS Identity and Access Management User Guide .

Returns:

See Also:



1821
1822
1823
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1821

def url_encode_child_manifest
  @url_encode_child_manifest
end

Class Method Details

.jsii_properties ⇒ Object 



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1823

def self.jsii_properties
  {
    :manifest_name => "manifestName",
    :child_manifest_name => "childManifestName",
    :filter_configuration => "filterConfiguration",
    :manifest_window_seconds => "manifestWindowSeconds",
    :program_date_time_interval_seconds => "programDateTimeIntervalSeconds",
    :scte_hls => "scteHls",
    :start_tag => "startTag",
    :uri_path_type => "uriPathType",
    :url => "url",
    :url_encode_child_manifest => "urlEncodeChildManifest",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
 
# File 'media_packagev2/cfn_origin_endpoint.rb', line 1838

def to_jsii
  result = {}
  result.merge!({
    "manifestName" => @manifest_name,
    "childManifestName" => @child_manifest_name,
    "filterConfiguration" => @filter_configuration,
    "manifestWindowSeconds" => @manifest_window_seconds,
    "programDateTimeIntervalSeconds" => @program_date_time_interval_seconds,
    "scteHls" => @scte_hls,
    "startTag" => @start_tag,
    "uriPathType" => @uri_path_type,
    "url" => @url,
    "urlEncodeChildManifest" => @url_encode_child_manifest,
  })
  result.compact
end