CfnPlaybackConfigurationProps

class aws_cdk.aws_mediatailor.CfnPlaybackConfigurationProps(*, ad_decision_server_url, name, video_content_source_url, avail_suppression=None, bumper=None, cdn_configuration=None, configuration_aliases=None, dash_configuration=None, hls_configuration=None, live_pre_roll_configuration=None, manifest_processing_rules=None, personalization_threshold_seconds=None, slate_ad_url=None, tags=None, transcode_profile_name=None)

Bases: object

Properties for defining a CfnPlaybackConfiguration.

Parameters
  • ad_decision_server_url (str) – The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

  • name (str) – The identifier for the playback configuration.

  • video_content_source_url (str) – The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

  • avail_suppression (Union[AvailSuppressionProperty, Dict[str, Any], IResolvable, None]) – The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression .

  • bumper (Union[BumperProperty, Dict[str, Any], IResolvable, None]) – The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers .

  • cdn_configuration (Union[CdnConfigurationProperty, Dict[str, Any], IResolvable, None]) – The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

  • configuration_aliases (Union[IResolvable, Mapping[str, Any], None]) – The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables .

  • dash_configuration (Union[DashConfigurationProperty, Dict[str, Any], IResolvable, None]) – The configuration for DASH content.

  • hls_configuration (Union[HlsConfigurationProperty, Dict[str, Any], IResolvable, None]) – AWS::MediaTailor::PlaybackConfiguration.HlsConfiguration.

  • live_pre_roll_configuration (Union[LivePreRollConfigurationProperty, Dict[str, Any], IResolvable, None]) – The configuration for pre-roll ad insertion.

  • manifest_processing_rules (Union[ManifestProcessingRulesProperty, Dict[str, Any], IResolvable, None]) – The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

  • personalization_threshold_seconds (Union[int, float, None]) – Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in MediaTailor .

  • slate_ad_url (Optional[str]) – The URL for a high-quality video asset to transcode and use to fill in time that’s not used by ads. MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to assign to the playback configuration.

  • transcode_profile_name (Optional[str]) – The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

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_mediatailor as mediatailor

# configuration_aliases: Any

cfn_playback_configuration_props = mediatailor.CfnPlaybackConfigurationProps(
    ad_decision_server_url="adDecisionServerUrl",
    name="name",
    video_content_source_url="videoContentSourceUrl",

    # the properties below are optional
    avail_suppression=mediatailor.CfnPlaybackConfiguration.AvailSuppressionProperty(
        mode="mode",
        value="value"
    ),
    bumper=mediatailor.CfnPlaybackConfiguration.BumperProperty(
        end_url="endUrl",
        start_url="startUrl"
    ),
    cdn_configuration=mediatailor.CfnPlaybackConfiguration.CdnConfigurationProperty(
        ad_segment_url_prefix="adSegmentUrlPrefix",
        content_segment_url_prefix="contentSegmentUrlPrefix"
    ),
    configuration_aliases={
        "configuration_aliases_key": configuration_aliases
    },
    dash_configuration=mediatailor.CfnPlaybackConfiguration.DashConfigurationProperty(
        manifest_endpoint_prefix="manifestEndpointPrefix",
        mpd_location="mpdLocation",
        origin_manifest_type="originManifestType"
    ),
    hls_configuration=mediatailor.CfnPlaybackConfiguration.HlsConfigurationProperty(
        manifest_endpoint_prefix="manifestEndpointPrefix"
    ),
    live_pre_roll_configuration=mediatailor.CfnPlaybackConfiguration.LivePreRollConfigurationProperty(
        ad_decision_server_url="adDecisionServerUrl",
        max_duration_seconds=123
    ),
    manifest_processing_rules=mediatailor.CfnPlaybackConfiguration.ManifestProcessingRulesProperty(
        ad_marker_passthrough=mediatailor.CfnPlaybackConfiguration.AdMarkerPassthroughProperty(
            enabled=False
        )
    ),
    personalization_threshold_seconds=123,
    slate_ad_url="slateAdUrl",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    transcode_profile_name="transcodeProfileName"
)

Attributes

ad_decision_server_url

The URL for the ad decision server (ADS).

This includes the specification of static parameters and placeholders for dynamic parameters. MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverurl

avail_suppression

The configuration for avail suppression, also known as ad suppression.

For more information about ad suppression, see Ad Suppression .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-availsuppression

bumper

The configuration for bumpers.

Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-bumper

cdn_configuration

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration

configuration_aliases

The player parameters and aliases used as dynamic variables during session initialization.

For more information, see Domain Variables .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-configurationaliases

dash_configuration

The configuration for DASH content.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration

hls_configuration

AWS::MediaTailor::PlaybackConfiguration.HlsConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-hlsconfiguration

live_pre_roll_configuration

The configuration for pre-roll ad insertion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration

manifest_processing_rules

The configuration for manifest processing rules.

Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-manifestprocessingrules

name

The identifier for the playback configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-name

personalization_threshold_seconds

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.

If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in MediaTailor .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-personalizationthresholdseconds

slate_ad_url

The URL for a high-quality video asset to transcode and use to fill in time that’s not used by ads.

MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-slateadurl

tags

The tags to assign to the playback configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-tags

transcode_profile_name

The name that is used to associate this playback configuration with a custom transcode profile.

This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-transcodeprofilename

video_content_source_url

The URL prefix for the parent manifest for the stream, minus the asset ID.

The maximum length is 512 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-videocontentsourceurl