CfnOriginEndpoint
- class aws_cdk.aws_mediapackagev2.CfnOriginEndpoint(scope, id, *, channel_group_name, channel_name, container_type, origin_endpoint_name, dash_manifests=None, description=None, force_endpoint_error_configuration=None, hls_manifests=None, low_latency_hls_manifests=None, segment=None, startover_window_seconds=None, tags=None)
Bases:
CfnResourceSpecifies the configuration parameters for a MediaPackage V2 origin endpoint.
- See:
- CloudformationResource:
AWS::MediaPackageV2::OriginEndpoint
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 cfn_origin_endpoint = mediapackagev2.CfnOriginEndpoint(self, "MyCfnOriginEndpoint", channel_group_name="channelGroupName", channel_name="channelName", container_type="containerType", origin_endpoint_name="originEndpointName", # the properties below are optional dash_manifests=[mediapackagev2.CfnOriginEndpoint.DashManifestConfigurationProperty( manifest_name="manifestName", # the properties below are optional base_urls=[mediapackagev2.CfnOriginEndpoint.DashBaseUrlProperty( url="url", # the properties below are optional dvb_priority=123, dvb_weight=123, service_location="serviceLocation" )], compactness="compactness", drm_signaling="drmSignaling", dvb_settings=mediapackagev2.CfnOriginEndpoint.DashDvbSettingsProperty( error_metrics=[mediapackagev2.CfnOriginEndpoint.DashDvbMetricsReportingProperty( reporting_url="reportingUrl", # the properties below are optional probability=123 )], font_download=mediapackagev2.CfnOriginEndpoint.DashDvbFontDownloadProperty( font_family="fontFamily", mime_type="mimeType", url="url" ) ), filter_configuration=mediapackagev2.CfnOriginEndpoint.FilterConfigurationProperty( clip_start_time="clipStartTime", end="end", manifest_filter="manifestFilter", start="start", time_delay_seconds=123 ), manifest_window_seconds=123, min_buffer_time_seconds=123, min_update_period_seconds=123, period_triggers=["periodTriggers"], profiles=["profiles"], program_information=mediapackagev2.CfnOriginEndpoint.DashProgramInformationProperty( copyright="copyright", language_code="languageCode", more_information_url="moreInformationUrl", source="source", title="title" ), scte_dash=mediapackagev2.CfnOriginEndpoint.ScteDashProperty( ad_marker_dash="adMarkerDash" ), segment_template_format="segmentTemplateFormat", subtitle_configuration=mediapackagev2.CfnOriginEndpoint.DashSubtitleConfigurationProperty( ttml_configuration=mediapackagev2.CfnOriginEndpoint.DashTtmlConfigurationProperty( ttml_profile="ttmlProfile" ) ), suggested_presentation_delay_seconds=123, utc_timing=mediapackagev2.CfnOriginEndpoint.DashUtcTimingProperty( timing_mode="timingMode", timing_source="timingSource" ) )], description="description", force_endpoint_error_configuration=mediapackagev2.CfnOriginEndpoint.ForceEndpointErrorConfigurationProperty( endpoint_error_conditions=["endpointErrorConditions"] ), hls_manifests=[mediapackagev2.CfnOriginEndpoint.HlsManifestConfigurationProperty( manifest_name="manifestName", # the properties below are optional child_manifest_name="childManifestName", filter_configuration=mediapackagev2.CfnOriginEndpoint.FilterConfigurationProperty( clip_start_time="clipStartTime", end="end", manifest_filter="manifestFilter", start="start", time_delay_seconds=123 ), manifest_window_seconds=123, program_date_time_interval_seconds=123, scte_hls=mediapackagev2.CfnOriginEndpoint.ScteHlsProperty( ad_marker_hls="adMarkerHls" ), start_tag=mediapackagev2.CfnOriginEndpoint.StartTagProperty( time_offset=123, # the properties below are optional precise=False ), url="url", url_encode_child_manifest=False )], low_latency_hls_manifests=[mediapackagev2.CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty( manifest_name="manifestName", # the properties below are optional child_manifest_name="childManifestName", filter_configuration=mediapackagev2.CfnOriginEndpoint.FilterConfigurationProperty( clip_start_time="clipStartTime", end="end", manifest_filter="manifestFilter", start="start", time_delay_seconds=123 ), manifest_window_seconds=123, program_date_time_interval_seconds=123, scte_hls=mediapackagev2.CfnOriginEndpoint.ScteHlsProperty( ad_marker_hls="adMarkerHls" ), start_tag=mediapackagev2.CfnOriginEndpoint.StartTagProperty( time_offset=123, # the properties below are optional precise=False ), url="url", url_encode_child_manifest=False )], segment=mediapackagev2.CfnOriginEndpoint.SegmentProperty( encryption=mediapackagev2.CfnOriginEndpoint.EncryptionProperty( encryption_method=mediapackagev2.CfnOriginEndpoint.EncryptionMethodProperty( cmaf_encryption_method="cmafEncryptionMethod", ts_encryption_method="tsEncryptionMethod" ), speke_key_provider=mediapackagev2.CfnOriginEndpoint.SpekeKeyProviderProperty( drm_systems=["drmSystems"], encryption_contract_configuration=mediapackagev2.CfnOriginEndpoint.EncryptionContractConfigurationProperty( preset_speke20_audio="presetSpeke20Audio", preset_speke20_video="presetSpeke20Video" ), resource_id="resourceId", role_arn="roleArn", url="url" ), # the properties below are optional constant_initialization_vector="constantInitializationVector", key_rotation_interval_seconds=123 ), include_iframe_only_streams=False, scte=mediapackagev2.CfnOriginEndpoint.ScteProperty( scte_filter=["scteFilter"] ), segment_duration_seconds=123, segment_name="segmentName", ts_include_dvb_subtitles=False, ts_use_audio_rendition_group=False ), startover_window_seconds=123, tags=[CfnTag( key="key", value="value" )] )
- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).channel_group_name (
str) – The name of the channel group associated with the origin endpoint configuration.channel_name (
str) – The channel name associated with the origin endpoint.container_type (
str) – The container type associated with the origin endpoint configuration.origin_endpoint_name (
str) – The name of the origin endpoint associated with the origin endpoint configuration.dash_manifests (
Union[IResolvable,Sequence[Union[IResolvable,DashManifestConfigurationProperty,Dict[str,Any]]],None]) – A DASH manifest configuration.description (
Optional[str]) – The description associated with the origin endpoint.force_endpoint_error_configuration (
Union[IResolvable,ForceEndpointErrorConfigurationProperty,Dict[str,Any],None]) – The failover settings for the endpoint.hls_manifests (
Union[IResolvable,Sequence[Union[IResolvable,HlsManifestConfigurationProperty,Dict[str,Any]]],None]) – The HLS manifests associated with the origin endpoint configuration.low_latency_hls_manifests (
Union[IResolvable,Sequence[Union[IResolvable,LowLatencyHlsManifestConfigurationProperty,Dict[str,Any]]],None]) – The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.segment (
Union[IResolvable,SegmentProperty,Dict[str,Any],None]) – The segment associated with the origin endpoint.startover_window_seconds (
Union[int,float,None]) – 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.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The tags associated with the origin endpoint.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
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:
target (
CfnResource)- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource)- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill 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 (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
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:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::MediaPackageV2::OriginEndpoint'
- attr_arn
The Amazon Resource Name (ARN) of the origin endpoint.
- CloudformationAttribute:
Arn
- attr_created_at
The timestamp of the creation of the origin endpoint.
- CloudformationAttribute:
CreatedAt
- attr_dash_manifest_urls
The egress domain URL for stream delivery from MediaPackage.
- CloudformationAttribute:
DashManifestUrls
- attr_hls_manifest_urls
The egress domain URL for stream delivery from MediaPackage.
- CloudformationAttribute:
HlsManifestUrls
- attr_low_latency_hls_manifest_urls
The egress domain URL for stream delivery from MediaPackage.
- CloudformationAttribute:
LowLatencyHlsManifestUrls
- attr_modified_at
The timestamp of the modification of the origin endpoint.
- CloudformationAttribute:
ModifiedAt
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- channel_group_name
The name of the channel group associated with the origin endpoint configuration.
- channel_name
The channel name associated with the origin endpoint.
- container_type
The container type associated with the origin endpoint configuration.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- dash_manifests
A DASH manifest configuration.
- description
The description associated with the origin endpoint.
- force_endpoint_error_configuration
The failover settings for the endpoint.
- hls_manifests
The HLS manifests associated with the origin endpoint configuration.
- logical_id
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
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- low_latency_hls_manifests
The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.
- node
The tree node.
- origin_endpoint_name
The name of the origin endpoint associated with the origin endpoint configuration.
- ref
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 }).
- segment
The segment associated with the origin endpoint.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- startover_window_seconds
The size of the window (in seconds) to specify a window of the live stream that’s available for on-demand viewing.
- tags
The tags associated with the origin endpoint.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
DashBaseUrlProperty
- class CfnOriginEndpoint.DashBaseUrlProperty(*, url, dvb_priority=None, dvb_weight=None, service_location=None)
Bases:
objectThe base URLs to use for retrieving segments.
You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows.
- Parameters:
url (
str) – A source location for segments.dvb_priority (
Union[int,float,None]) – For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority.dvb_weight (
Union[int,float,None]) – For use with DVB-DASH profiles only. The weighting for source locations that have the same priority.service_location (
Optional[str]) – The name of the source location.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 dash_base_url_property = mediapackagev2.CfnOriginEndpoint.DashBaseUrlProperty( url="url", # the properties below are optional dvb_priority=123, dvb_weight=123, service_location="serviceLocation" )
Attributes
- dvb_priority
For use with DVB-DASH profiles only.
The priority of this location for servings segments. The lower the number, the higher the priority.
- dvb_weight
For use with DVB-DASH profiles only.
The weighting for source locations that have the same priority.
- service_location
The name of the source location.
DashDvbFontDownloadProperty
- class CfnOriginEndpoint.DashDvbFontDownloadProperty(*, font_family=None, mime_type=None, url=None)
Bases:
objectFor use with DVB-DASH profiles only.
The settings for font downloads that you want AWS Elemental MediaPackage to pass through to the manifest.
- Parameters:
font_family (
Optional[str]) – ThefontFamilyname for subtitles, as described in EBU-TT-D Subtitling Distribution Format .mime_type (
Optional[str]) – ThemimeTypeof the resource that’s at the font download URL. For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.url (
Optional[str]) – The URL for downloading fonts for subtitles.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 dash_dvb_font_download_property = mediapackagev2.CfnOriginEndpoint.DashDvbFontDownloadProperty( font_family="fontFamily", mime_type="mimeType", url="url" )
Attributes
- font_family
The
fontFamilyname for subtitles, as described in EBU-TT-D Subtitling Distribution Format .
- mime_type
The
mimeTypeof the resource that’s at the font download URL.For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.
- url
The URL for downloading fonts for subtitles.
DashDvbMetricsReportingProperty
- class CfnOriginEndpoint.DashDvbMetricsReportingProperty(*, reporting_url, probability=None)
Bases:
objectFor use with DVB-DASH profiles only.
The settings for error reporting from the playback device that you want AWS Elemental MediaPackage to pass through to the manifest.
- Parameters:
reporting_url (
str) – The URL where playback devices send error reports.probability (
Union[int,float,None]) – The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 dash_dvb_metrics_reporting_property = mediapackagev2.CfnOriginEndpoint.DashDvbMetricsReportingProperty( reporting_url="reportingUrl", # the properties below are optional probability=123 )
Attributes
- probability
The number of playback devices per 1000 that will send error reports to the reporting URL.
This represents the probability that a playback device will be a reporting player for this session.
- reporting_url
The URL where playback devices send error reports.
DashDvbSettingsProperty
- class CfnOriginEndpoint.DashDvbSettingsProperty(*, error_metrics=None, font_download=None)
Bases:
objectFor endpoints that use the DVB-DASH profile only.
The font download and error reporting information that you want MediaPackage to pass through to the manifest.
- Parameters:
error_metrics (
Union[IResolvable,Sequence[Union[IResolvable,DashDvbMetricsReportingProperty,Dict[str,Any]]],None]) – Playback device error reporting settings.font_download (
Union[IResolvable,DashDvbFontDownloadProperty,Dict[str,Any],None]) – Subtitle font settings.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 dash_dvb_settings_property = mediapackagev2.CfnOriginEndpoint.DashDvbSettingsProperty( error_metrics=[mediapackagev2.CfnOriginEndpoint.DashDvbMetricsReportingProperty( reporting_url="reportingUrl", # the properties below are optional probability=123 )], font_download=mediapackagev2.CfnOriginEndpoint.DashDvbFontDownloadProperty( font_family="fontFamily", mime_type="mimeType", url="url" ) )
Attributes
- error_metrics
Playback device error reporting settings.
DashManifestConfigurationProperty
- class CfnOriginEndpoint.DashManifestConfigurationProperty(*, manifest_name, base_urls=None, compactness=None, drm_signaling=None, dvb_settings=None, filter_configuration=None, manifest_window_seconds=None, min_buffer_time_seconds=None, min_update_period_seconds=None, period_triggers=None, profiles=None, program_information=None, scte_dash=None, segment_template_format=None, subtitle_configuration=None, suggested_presentation_delay_seconds=None, utc_timing=None)
Bases:
objectThe DASH manifest configuration associated with the origin endpoint.
- Parameters:
manifest_name (
str) – A short string that’s appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.base_urls (
Union[IResolvable,Sequence[Union[IResolvable,DashBaseUrlProperty,Dict[str,Any]]],None]) – The base URLs to use for retrieving segments.compactness (
Optional[str]) – The layout of the DASH manifest that MediaPackage produces.STANDARDindicates a default manifest, which is compacted.NONEindicates a full manifest. For information about compactness, see DASH manifest compactness in the AWS Elemental MediaPackage v2 User Guide .drm_signaling (
Optional[str]) – Determines how the DASH manifest signals the DRM content.dvb_settings (
Union[IResolvable,DashDvbSettingsProperty,Dict[str,Any],None]) – For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.filter_configuration (
Union[IResolvable,FilterConfigurationProperty,Dict[str,Any],None]) – 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 (
Union[int,float,None]) – The total duration (in seconds) of the manifest’s content.min_buffer_time_seconds (
Union[int,float,None]) – Minimum amount of content (in seconds) that a player must keep available in the buffer.min_update_period_seconds (
Union[int,float,None]) – Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.period_triggers (
Optional[Sequence[str]]) – A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. TypeADSto indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage .profiles (
Optional[Sequence[str]]) – The profile that the output is compliant with.program_information (
Union[IResolvable,DashProgramInformationProperty,Dict[str,Any],None]) – Details about the content that you want MediaPackage to pass through in the manifest to the playback device.scte_dash (
Union[IResolvable,ScteDashProperty,Dict[str,Any],None]) – The SCTE configuration.segment_template_format (
Optional[str]) – Determines the type of variable used in themediaURL of theSegmentTemplatetag in the manifest. Also specifies if segment timeline information is included inSegmentTimelineorSegmentTemplate. Value description: -NUMBER_WITH_TIMELINE- The$Number$variable is used in themediaURL. The value of this variable is the sequential number of the segment. A fullSegmentTimelineobject is presented in eachSegmentTemplate.subtitle_configuration (
Union[IResolvable,DashSubtitleConfigurationProperty,Dict[str,Any],None]) – The configuration for DASH subtitles.suggested_presentation_delay_seconds (
Union[int,float,None]) – The amount of time (in seconds) that the player should be from the end of the manifest.utc_timing (
Union[IResolvable,DashUtcTimingProperty,Dict[str,Any],None]) – Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 dash_manifest_configuration_property = mediapackagev2.CfnOriginEndpoint.DashManifestConfigurationProperty( manifest_name="manifestName", # the properties below are optional base_urls=[mediapackagev2.CfnOriginEndpoint.DashBaseUrlProperty( url="url", # the properties below are optional dvb_priority=123, dvb_weight=123, service_location="serviceLocation" )], compactness="compactness", drm_signaling="drmSignaling", dvb_settings=mediapackagev2.CfnOriginEndpoint.DashDvbSettingsProperty( error_metrics=[mediapackagev2.CfnOriginEndpoint.DashDvbMetricsReportingProperty( reporting_url="reportingUrl", # the properties below are optional probability=123 )], font_download=mediapackagev2.CfnOriginEndpoint.DashDvbFontDownloadProperty( font_family="fontFamily", mime_type="mimeType", url="url" ) ), filter_configuration=mediapackagev2.CfnOriginEndpoint.FilterConfigurationProperty( clip_start_time="clipStartTime", end="end", manifest_filter="manifestFilter", start="start", time_delay_seconds=123 ), manifest_window_seconds=123, min_buffer_time_seconds=123, min_update_period_seconds=123, period_triggers=["periodTriggers"], profiles=["profiles"], program_information=mediapackagev2.CfnOriginEndpoint.DashProgramInformationProperty( copyright="copyright", language_code="languageCode", more_information_url="moreInformationUrl", source="source", title="title" ), scte_dash=mediapackagev2.CfnOriginEndpoint.ScteDashProperty( ad_marker_dash="adMarkerDash" ), segment_template_format="segmentTemplateFormat", subtitle_configuration=mediapackagev2.CfnOriginEndpoint.DashSubtitleConfigurationProperty( ttml_configuration=mediapackagev2.CfnOriginEndpoint.DashTtmlConfigurationProperty( ttml_profile="ttmlProfile" ) ), suggested_presentation_delay_seconds=123, utc_timing=mediapackagev2.CfnOriginEndpoint.DashUtcTimingProperty( timing_mode="timingMode", timing_source="timingSource" ) )
Attributes
- base_urls
The base URLs to use for retrieving segments.
- compactness
The layout of the DASH manifest that MediaPackage produces.
STANDARDindicates a default manifest, which is compacted.NONEindicates a full manifest.For information about compactness, see DASH manifest compactness in the AWS Elemental MediaPackage v2 User Guide .
- drm_signaling
Determines how the DASH manifest signals the DRM content.
- dvb_settings
For endpoints that use the DVB-DASH profile only.
The font download and error reporting information that you want MediaPackage to pass through to the manifest.
- filter_configuration
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_name
A short string that’s appended to the endpoint URL.
The child manifest name creates a unique path to this endpoint.
- manifest_window_seconds
The total duration (in seconds) of the manifest’s content.
- min_buffer_time_seconds
Minimum amount of content (in seconds) that a player must keep available in the buffer.
- min_update_period_seconds
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
- period_triggers
A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods.
Type
ADSto indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage .
- profiles
The profile that the output is compliant with.
- program_information
Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
- scte_dash
The SCTE configuration.
- segment_template_format
Determines the type of variable used in the
mediaURL of theSegmentTemplatetag in the manifest.Also specifies if segment timeline information is included in
SegmentTimelineorSegmentTemplate.Value description:
NUMBER_WITH_TIMELINE- The$Number$variable is used in themediaURL. The value of this variable is the sequential number of the segment. A fullSegmentTimelineobject is presented in eachSegmentTemplate.
- subtitle_configuration
The configuration for DASH subtitles.
- suggested_presentation_delay_seconds
The amount of time (in seconds) that the player should be from the end of the manifest.
- utc_timing
Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
DashProgramInformationProperty
- class CfnOriginEndpoint.DashProgramInformationProperty(*, copyright=None, language_code=None, more_information_url=None, source=None, title=None)
Bases:
objectDetails about the content that you want MediaPackage to pass through in the manifest to the playback device.
- Parameters:
copyright (
Optional[str]) – A copyright statement about the content.language_code (
Optional[str]) – The language code for this manifest.more_information_url (
Optional[str]) – An absolute URL that contains more information about this content.source (
Optional[str]) – Information about the content provider.title (
Optional[str]) – The title for the manifest.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 dash_program_information_property = mediapackagev2.CfnOriginEndpoint.DashProgramInformationProperty( copyright="copyright", language_code="languageCode", more_information_url="moreInformationUrl", source="source", title="title" )
Attributes
- copyright
A copyright statement about the content.
- language_code
The language code for this manifest.
- more_information_url
An absolute URL that contains more information about this content.
- source
Information about the content provider.
DashSubtitleConfigurationProperty
- class CfnOriginEndpoint.DashSubtitleConfigurationProperty(*, ttml_configuration=None)
Bases:
objectThe configuration for DASH subtitles.
- Parameters:
ttml_configuration (
Union[IResolvable,DashTtmlConfigurationProperty,Dict[str,Any],None]) – Settings for TTML subtitles.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 dash_subtitle_configuration_property = mediapackagev2.CfnOriginEndpoint.DashSubtitleConfigurationProperty( ttml_configuration=mediapackagev2.CfnOriginEndpoint.DashTtmlConfigurationProperty( ttml_profile="ttmlProfile" ) )
Attributes
DashTtmlConfigurationProperty
- class CfnOriginEndpoint.DashTtmlConfigurationProperty(*, ttml_profile)
Bases:
objectThe settings for TTML subtitles.
- Parameters:
ttml_profile (
str) –The profile that MediaPackage uses when signaling subtitles in the manifest.
IMSCis the default profile.EBU-TT-Dproduces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format .- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 dash_ttml_configuration_property = mediapackagev2.CfnOriginEndpoint.DashTtmlConfigurationProperty( ttml_profile="ttmlProfile" )
Attributes
- ttml_profile
The profile that MediaPackage uses when signaling subtitles in the manifest.
IMSCis the default profile.EBU-TT-Dproduces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format .
DashUtcTimingProperty
- class CfnOriginEndpoint.DashUtcTimingProperty(*, timing_mode=None, timing_source=None)
Bases:
objectDetermines the type of UTC timing included in the DASH Media Presentation Description (MPD).
- Parameters:
timing_mode (
Optional[str]) – The UTC timing mode.timing_source (
Optional[str]) – The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 dash_utc_timing_property = mediapackagev2.CfnOriginEndpoint.DashUtcTimingProperty( timing_mode="timingMode", timing_source="timingSource" )
Attributes
- timing_mode
The UTC timing mode.
- timing_source
The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.
EncryptionContractConfigurationProperty
- class CfnOriginEndpoint.EncryptionContractConfigurationProperty(*, preset_speke20_audio, preset_speke20_video)
Bases:
objectUse
encryptionContractConfigurationto configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.- Parameters:
preset_speke20_audio (
str) – A collection of audio encryption presets. Value description: -PRESET-AUDIO-1- Use one content key to encrypt all of the audio tracks in your stream. -PRESET-AUDIO-2- Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks. -PRESET-AUDIO-3- Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels. -SHARED- Use the same content key for all of the audio and video tracks in your stream. -UNENCRYPTED- Don’t encrypt any of the audio tracks in your stream.preset_speke20_video (
str) – The SPEKE Version 2.0 preset video associated with the encryption contract configuration of the origin endpoint. A collection of video encryption presets. Value description: -PRESET-VIDEO-1- Use one content key to encrypt all of the video tracks in your stream. -PRESET-VIDEO-2- Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks. -PRESET-VIDEO-3- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks. -PRESET-VIDEO-4- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. -PRESET-VIDEO-5- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. -PRESET-VIDEO-6- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. -PRESET-VIDEO-7- Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. -PRESET-VIDEO-8- Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. -SHARED- Use the same content key for all of the video and audio tracks in your stream. -UNENCRYPTED- Don’t encrypt any of the video tracks in your stream.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 encryption_contract_configuration_property = mediapackagev2.CfnOriginEndpoint.EncryptionContractConfigurationProperty( preset_speke20_audio="presetSpeke20Audio", preset_speke20_video="presetSpeke20Video" )
Attributes
- preset_speke20_audio
A collection of audio encryption presets.
Value description:
PRESET-AUDIO-1- Use one content key to encrypt all of the audio tracks in your stream.PRESET-AUDIO-2- Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.PRESET-AUDIO-3- Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.SHARED- Use the same content key for all of the audio and video tracks in your stream.UNENCRYPTED- Don’t encrypt any of the audio tracks in your stream.
- preset_speke20_video
The SPEKE Version 2.0 preset video associated with the encryption contract configuration of the origin endpoint.
A collection of video encryption presets.
Value description:
PRESET-VIDEO-1- Use one content key to encrypt all of the video tracks in your stream.PRESET-VIDEO-2- Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.PRESET-VIDEO-3- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.PRESET-VIDEO-4- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.PRESET-VIDEO-5- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.PRESET-VIDEO-6- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.PRESET-VIDEO-7- Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.PRESET-VIDEO-8- Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.SHARED- Use the same content key for all of the video and audio tracks in your stream.UNENCRYPTED- Don’t encrypt any of the video tracks in your stream.
EncryptionMethodProperty
- class CfnOriginEndpoint.EncryptionMethodProperty(*, cmaf_encryption_method=None, ts_encryption_method=None)
Bases:
objectThe encryption method associated with the origin endpoint.
- Parameters:
cmaf_encryption_method (
Optional[str]) – The encryption method to use.ts_encryption_method (
Optional[str]) – The encryption method to use.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 encryption_method_property = mediapackagev2.CfnOriginEndpoint.EncryptionMethodProperty( cmaf_encryption_method="cmafEncryptionMethod", ts_encryption_method="tsEncryptionMethod" )
Attributes
- cmaf_encryption_method
The encryption method to use.
- ts_encryption_method
The encryption method to use.
EncryptionProperty
- class CfnOriginEndpoint.EncryptionProperty(*, encryption_method, speke_key_provider, constant_initialization_vector=None, key_rotation_interval_seconds=None)
Bases:
objectThe parameters for encrypting content.
- Parameters:
encryption_method (
Union[IResolvable,EncryptionMethodProperty,Dict[str,Any]]) – The encryption method to use.speke_key_provider (
Union[IResolvable,SpekeKeyProviderProperty,Dict[str,Any]]) – The SPEKE key provider to use for encryption.constant_initialization_vector (
Optional[str]) – A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don’t specify a value, then MediaPackage creates the constant initialization vector (IV).key_rotation_interval_seconds (
Union[int,float,None]) – The interval, in seconds, to rotate encryption keys for the origin endpoint.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 encryption_property = mediapackagev2.CfnOriginEndpoint.EncryptionProperty( encryption_method=mediapackagev2.CfnOriginEndpoint.EncryptionMethodProperty( cmaf_encryption_method="cmafEncryptionMethod", ts_encryption_method="tsEncryptionMethod" ), speke_key_provider=mediapackagev2.CfnOriginEndpoint.SpekeKeyProviderProperty( drm_systems=["drmSystems"], encryption_contract_configuration=mediapackagev2.CfnOriginEndpoint.EncryptionContractConfigurationProperty( preset_speke20_audio="presetSpeke20Audio", preset_speke20_video="presetSpeke20Video" ), resource_id="resourceId", role_arn="roleArn", url="url" ), # the properties below are optional constant_initialization_vector="constantInitializationVector", key_rotation_interval_seconds=123 )
Attributes
- constant_initialization_vector
A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content.
If you don’t specify a value, then MediaPackage creates the constant initialization vector (IV).
- encryption_method
The encryption method to use.
- key_rotation_interval_seconds
The interval, in seconds, to rotate encryption keys for the origin endpoint.
- speke_key_provider
The SPEKE key provider to use for encryption.
FilterConfigurationProperty
- class CfnOriginEndpoint.FilterConfigurationProperty(*, clip_start_time=None, end=None, manifest_filter=None, start=None, time_delay_seconds=None)
Bases:
objectFilter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.
- Parameters:
clip_start_time (
Optional[str]) – Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest’s endpoint URL.end (
Optional[str]) – Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest’s endpoint URL.manifest_filter (
Optional[str]) – Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest’s endpoint URL.start (
Optional[str]) – Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest’s endpoint URL.time_delay_seconds (
Union[int,float,None]) – Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint’s startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest’s endpoint URL.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 filter_configuration_property = mediapackagev2.CfnOriginEndpoint.FilterConfigurationProperty( clip_start_time="clipStartTime", end="end", manifest_filter="manifestFilter", start="start", time_delay_seconds=123 )
Attributes
- clip_start_time
Optionally specify the clip start time for all of your manifest egress requests.
When you include clip start time, note that you cannot use clip start time query parameters for this manifest’s endpoint URL.
- end
Optionally specify the end time for all of your manifest egress requests.
When you include end time, note that you cannot use end time query parameters for this manifest’s endpoint URL.
- manifest_filter
Optionally specify one or more manifest filters for all of your manifest egress requests.
When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest’s endpoint URL.
- start
Optionally specify the start time for all of your manifest egress requests.
When you include start time, note that you cannot use start time query parameters for this manifest’s endpoint URL.
- time_delay_seconds
Optionally specify the time delay for all of your manifest egress requests.
Enter a value that is smaller than your endpoint’s startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest’s endpoint URL.
ForceEndpointErrorConfigurationProperty
- class CfnOriginEndpoint.ForceEndpointErrorConfigurationProperty(*, endpoint_error_conditions=None)
Bases:
objectThe failover settings for the endpoint.
- Parameters:
endpoint_error_conditions (
Optional[Sequence[str]]) – The failover conditions for the endpoint. The options are:. -STALE_MANIFEST- The manifest stalled and there are no new segments or parts. -INCOMPLETE_MANIFEST- There is a gap in the manifest. -MISSING_DRM_KEY- Key rotation is enabled but we’re unable to fetch the key for the current key period. -SLATE_INPUT- The segments which contain slate content are considered to be missing content.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 force_endpoint_error_configuration_property = mediapackagev2.CfnOriginEndpoint.ForceEndpointErrorConfigurationProperty( endpoint_error_conditions=["endpointErrorConditions"] )
Attributes
- endpoint_error_conditions
.
STALE_MANIFEST- The manifest stalled and there are no new segments or parts.INCOMPLETE_MANIFEST- There is a gap in the manifest.MISSING_DRM_KEY- Key rotation is enabled but we’re unable to fetch the key for the current key period.SLATE_INPUT- The segments which contain slate content are considered to be missing content.
- See:
- Type:
The failover conditions for the endpoint. The options are
HlsManifestConfigurationProperty
- class CfnOriginEndpoint.HlsManifestConfigurationProperty(*, manifest_name, child_manifest_name=None, filter_configuration=None, manifest_window_seconds=None, program_date_time_interval_seconds=None, scte_hls=None, start_tag=None, url=None, url_encode_child_manifest=None)
Bases:
objectThe HLS manifest configuration associated with the origin endpoint.
- Parameters:
manifest_name (
str) – The name of the manifest associated with the HLS manifest configuration.child_manifest_name (
Optional[str]) – The name of the child manifest associated with the HLS manifest configuration.filter_configuration (
Union[IResolvable,FilterConfigurationProperty,Dict[str,Any],None]) – 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 (
Union[int,float,None]) – The duration of the manifest window, in seconds, for the HLS manifest configuration.program_date_time_interval_seconds (
Union[int,float,None]) – TheEXT-X-PROGRAM-DATE-TIMEinterval, in seconds, associated with the HLS manifest configuration.scte_hls (
Union[IResolvable,ScteHlsProperty,Dict[str,Any],None]) – THE SCTE-35 HLS configuration associated with the HLS manifest configuration.start_tag (
Union[IResolvable,StartTagProperty,Dict[str,Any],None]) – 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.url (
Optional[str]) – The URL of the HLS manifest configuration.url_encode_child_manifest (
Union[bool,IResolvable,None]) – 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 .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 hls_manifest_configuration_property = mediapackagev2.CfnOriginEndpoint.HlsManifestConfigurationProperty( manifest_name="manifestName", # the properties below are optional child_manifest_name="childManifestName", filter_configuration=mediapackagev2.CfnOriginEndpoint.FilterConfigurationProperty( clip_start_time="clipStartTime", end="end", manifest_filter="manifestFilter", start="start", time_delay_seconds=123 ), manifest_window_seconds=123, program_date_time_interval_seconds=123, scte_hls=mediapackagev2.CfnOriginEndpoint.ScteHlsProperty( ad_marker_hls="adMarkerHls" ), start_tag=mediapackagev2.CfnOriginEndpoint.StartTagProperty( time_offset=123, # the properties below are optional precise=False ), url="url", url_encode_child_manifest=False )
Attributes
- child_manifest_name
The name of the child manifest associated with the HLS manifest configuration.
- filter_configuration
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_name
The name of the manifest associated with the HLS manifest configuration.
- manifest_window_seconds
The duration of the manifest window, in seconds, for the HLS manifest configuration.
- program_date_time_interval_seconds
The
EXT-X-PROGRAM-DATE-TIMEinterval, in seconds, associated with the HLS manifest configuration.
- scte_hls
THE SCTE-35 HLS configuration associated with the HLS manifest configuration.
- start_tag
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.
- url
The URL of the HLS manifest configuration.
- url_encode_child_manifest
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 .
LowLatencyHlsManifestConfigurationProperty
- class CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty(*, manifest_name, child_manifest_name=None, filter_configuration=None, manifest_window_seconds=None, program_date_time_interval_seconds=None, scte_hls=None, start_tag=None, url=None, url_encode_child_manifest=None)
Bases:
objectSpecify a low-latency HTTP live streaming (LL-HLS) manifest configuration.
- Parameters:
manifest_name (
str) – A short string that’s appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default manifest name,index. MediaPackage automatically inserts the format extension, such as.m3u8. You can’t use the same manifest name if you use HLS manifest and low-latency HLS manifest. ThemanifestNameon theHLSManifestobject overrides themanifestNameyou provided on theoriginEndpointobject.child_manifest_name (
Optional[str]) – The name of the child manifest associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.filter_configuration (
Union[IResolvable,FilterConfigurationProperty,Dict[str,Any],None]) – 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 (
Union[int,float,None]) – The total duration (in seconds) of the manifest’s content.program_date_time_interval_seconds (
Union[int,float,None]) – InsertsEXT-X-PROGRAM-DATE-TIMEtags in the output manifest at the interval that you specify. If you don’t enter an interval,EXT-X-PROGRAM-DATE-TIMEtags aren’t included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if anyID3Timedmetadata is in the HLS input, MediaPackage passes through that metadata to the HLS output.scte_hls (
Union[IResolvable,ScteHlsProperty,Dict[str,Any],None]) – The SCTE-35 HLS configuration associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.start_tag (
Union[IResolvable,StartTagProperty,Dict[str,Any],None]) – 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.url (
Optional[str]) – The URL of the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.url_encode_child_manifest (
Union[bool,IResolvable,None]) –When enabled, MediaPackage URL-encodes the query string for API requests for LL-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 .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 low_latency_hls_manifest_configuration_property = mediapackagev2.CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty( manifest_name="manifestName", # the properties below are optional child_manifest_name="childManifestName", filter_configuration=mediapackagev2.CfnOriginEndpoint.FilterConfigurationProperty( clip_start_time="clipStartTime", end="end", manifest_filter="manifestFilter", start="start", time_delay_seconds=123 ), manifest_window_seconds=123, program_date_time_interval_seconds=123, scte_hls=mediapackagev2.CfnOriginEndpoint.ScteHlsProperty( ad_marker_hls="adMarkerHls" ), start_tag=mediapackagev2.CfnOriginEndpoint.StartTagProperty( time_offset=123, # the properties below are optional precise=False ), url="url", url_encode_child_manifest=False )
Attributes
- child_manifest_name
The name of the child manifest associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.
- filter_configuration
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_name
A short string that’s appended to the endpoint URL.
The manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default manifest name,
index. MediaPackage automatically inserts the format extension, such as.m3u8. You can’t use the same manifest name if you use HLS manifest and low-latency HLS manifest. ThemanifestNameon theHLSManifestobject overrides themanifestNameyou provided on theoriginEndpointobject.
- manifest_window_seconds
The total duration (in seconds) of the manifest’s content.
- program_date_time_interval_seconds
Inserts
EXT-X-PROGRAM-DATE-TIMEtags in the output manifest at the interval that you specify.If you don’t enter an interval,
EXT-X-PROGRAM-DATE-TIMEtags aren’t included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.Irrespective of this parameter, if any
ID3Timedmetadata is in the HLS input, MediaPackage passes through that metadata to the HLS output.
- scte_hls
The SCTE-35 HLS configuration associated with the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.
- start_tag
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.
- url
The URL of the low-latency HLS (LL-HLS) manifest configuration of the origin endpoint.
- url_encode_child_manifest
When enabled, MediaPackage URL-encodes the query string for API requests for LL-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 .
ScteDashProperty
- class CfnOriginEndpoint.ScteDashProperty(*, ad_marker_dash=None)
Bases:
objectThe SCTE configuration.
- Parameters:
ad_marker_dash (
Optional[str]) – Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Value description: -Binary- The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML. -XML- The SCTE marker is expressed fully in XML.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 scte_dash_property = mediapackagev2.CfnOriginEndpoint.ScteDashProperty( ad_marker_dash="adMarkerDash" )
Attributes
- ad_marker_dash
Choose how ad markers are included in the packaged content.
If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.
Value description:
Binary- The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.XML- The SCTE marker is expressed fully in XML.
ScteHlsProperty
- class CfnOriginEndpoint.ScteHlsProperty(*, ad_marker_hls=None)
Bases:
objectThe SCTE-35 HLS configuration associated with the origin endpoint.
- Parameters:
ad_marker_hls (
Optional[str]) – The SCTE-35 HLS ad-marker configuration.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 scte_hls_property = mediapackagev2.CfnOriginEndpoint.ScteHlsProperty( ad_marker_hls="adMarkerHls" )
Attributes
- ad_marker_hls
The SCTE-35 HLS ad-marker configuration.
ScteProperty
- class CfnOriginEndpoint.ScteProperty(*, scte_filter=None)
Bases:
objectThe SCTE-35 configuration associated with the origin endpoint.
- Parameters:
scte_filter (
Optional[Sequence[str]]) – The filter associated with the SCTE-35 configuration.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 scte_property = mediapackagev2.CfnOriginEndpoint.ScteProperty( scte_filter=["scteFilter"] )
Attributes
- scte_filter
The filter associated with the SCTE-35 configuration.
SegmentProperty
- class CfnOriginEndpoint.SegmentProperty(*, encryption=None, include_iframe_only_streams=None, scte=None, segment_duration_seconds=None, segment_name=None, ts_include_dvb_subtitles=None, ts_use_audio_rendition_group=None)
Bases:
objectThe segment configuration, including the segment name, duration, and other configuration values.
- Parameters:
encryption (
Union[IResolvable,EncryptionProperty,Dict[str,Any],None]) – Whether to use encryption for the segment.include_iframe_only_streams (
Union[bool,IResolvable,None]) – Whether the segment includes I-frame-only streams.scte (
Union[IResolvable,ScteProperty,Dict[str,Any],None]) – The SCTE-35 configuration associated with the segment.segment_duration_seconds (
Union[int,float,None]) – The duration of the segment, in seconds.segment_name (
Optional[str]) – The name of the segment associated with the origin endpoint.ts_include_dvb_subtitles (
Union[bool,IResolvable,None]) – Whether the segment includes DVB subtitles.ts_use_audio_rendition_group (
Union[bool,IResolvable,None]) – Whether the segment is an audio rendition group.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 segment_property = mediapackagev2.CfnOriginEndpoint.SegmentProperty( encryption=mediapackagev2.CfnOriginEndpoint.EncryptionProperty( encryption_method=mediapackagev2.CfnOriginEndpoint.EncryptionMethodProperty( cmaf_encryption_method="cmafEncryptionMethod", ts_encryption_method="tsEncryptionMethod" ), speke_key_provider=mediapackagev2.CfnOriginEndpoint.SpekeKeyProviderProperty( drm_systems=["drmSystems"], encryption_contract_configuration=mediapackagev2.CfnOriginEndpoint.EncryptionContractConfigurationProperty( preset_speke20_audio="presetSpeke20Audio", preset_speke20_video="presetSpeke20Video" ), resource_id="resourceId", role_arn="roleArn", url="url" ), # the properties below are optional constant_initialization_vector="constantInitializationVector", key_rotation_interval_seconds=123 ), include_iframe_only_streams=False, scte=mediapackagev2.CfnOriginEndpoint.ScteProperty( scte_filter=["scteFilter"] ), segment_duration_seconds=123, segment_name="segmentName", ts_include_dvb_subtitles=False, ts_use_audio_rendition_group=False )
Attributes
- encryption
Whether to use encryption for the segment.
- include_iframe_only_streams
Whether the segment includes I-frame-only streams.
- scte
The SCTE-35 configuration associated with the segment.
- segment_duration_seconds
The duration of the segment, in seconds.
- segment_name
The name of the segment associated with the origin endpoint.
- ts_include_dvb_subtitles
Whether the segment includes DVB subtitles.
- ts_use_audio_rendition_group
Whether the segment is an audio rendition group.
SpekeKeyProviderProperty
- class CfnOriginEndpoint.SpekeKeyProviderProperty(*, drm_systems, encryption_contract_configuration, resource_id, role_arn, url)
Bases:
objectThe parameters for the SPEKE key provider.
- Parameters:
drm_systems (
Sequence[str]) – The DRM solution provider you’re using to protect your content during distribution.encryption_contract_configuration (
Union[IResolvable,EncryptionContractConfigurationProperty,Dict[str,Any]]) – The encryption contract configuration associated with the SPEKE key provider.resource_id (
str) – The unique identifier for the content. The service sends this identifier to the key server to identify the current endpoint. How unique you make this identifier depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID. The following example shows a resource ID:MovieNight20171126093045role_arn (
str) – The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider. Valid format:arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN:arn:aws:iam::444455556666:role/SpekeAccessurl (
str) – The URL of the SPEKE key provider.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 speke_key_provider_property = mediapackagev2.CfnOriginEndpoint.SpekeKeyProviderProperty( drm_systems=["drmSystems"], encryption_contract_configuration=mediapackagev2.CfnOriginEndpoint.EncryptionContractConfigurationProperty( preset_speke20_audio="presetSpeke20Audio", preset_speke20_video="presetSpeke20Video" ), resource_id="resourceId", role_arn="roleArn", url="url" )
Attributes
- drm_systems
The DRM solution provider you’re using to protect your content during distribution.
- encryption_contract_configuration
The encryption contract configuration associated with the SPEKE key provider.
- resource_id
The unique identifier for the content.
The service sends this identifier to the key server to identify the current endpoint. How unique you make this identifier depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
The following example shows a resource ID:
MovieNight20171126093045
- role_arn
The ARN for the IAM role granted by the key provider that provides access to the key provider API.
This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
Valid format:
arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN:arn:aws:iam::444455556666:role/SpekeAccess
StartTagProperty
- class CfnOriginEndpoint.StartTagProperty(*, time_offset, precise=None)
Bases:
objectTo 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.
- Parameters:
time_offset (
Union[int,float]) – Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration.precise (
Union[bool,IResolvable,None]) – Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_mediapackagev2 as mediapackagev2 start_tag_property = mediapackagev2.CfnOriginEndpoint.StartTagProperty( time_offset=123, # the properties below are optional precise=False )
Attributes
- precise
Specify the value for PRECISE within your EXT-X-START tag.
Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES.
- time_offset
Specify the value for TIME-OFFSET within your EXT-X-START tag.
Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration.