CfnPlaybackConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_mediatailor.mixins.CfnPlaybackConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

Adds a new playback configuration to AWS Elemental MediaTailor .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html
CloudformationResource:: AWS::MediaTailor::PlaybackConfiguration
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

# configuration_aliases: Any

cfn_playback_configuration_props_mixin = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin(mediatailor_mixins.CfnPlaybackConfigurationMixinProps(
    ad_conditioning_configuration=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AdConditioningConfigurationProperty(
        streaming_media_file_conditioning="streamingMediaFileConditioning"
    ),
    ad_decision_server_url="adDecisionServerUrl",
    avail_suppression=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AvailSuppressionProperty(
        fill_policy="fillPolicy",
        mode="mode",
        value="value"
    ),
    bumper=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.BumperProperty(
        end_url="endUrl",
        start_url="startUrl"
    ),
    cdn_configuration=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.CdnConfigurationProperty(
        ad_segment_url_prefix="adSegmentUrlPrefix",
        content_segment_url_prefix="contentSegmentUrlPrefix"
    ),
    configuration_aliases={
        "configuration_aliases_key": configuration_aliases
    },
    dash_configuration=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.DashConfigurationProperty(
        manifest_endpoint_prefix="manifestEndpointPrefix",
        mpd_location="mpdLocation",
        origin_manifest_type="originManifestType"
    ),
    hls_configuration=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.HlsConfigurationProperty(
        manifest_endpoint_prefix="manifestEndpointPrefix"
    ),
    insertion_mode="insertionMode",
    live_pre_roll_configuration=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.LivePreRollConfigurationProperty(
        ad_decision_server_url="adDecisionServerUrl",
        max_duration_seconds=123
    ),
    log_configuration=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.LogConfigurationProperty(
        ads_interaction_log=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AdsInteractionLogProperty(
            exclude_event_types=["excludeEventTypes"],
            publish_opt_in_event_types=["publishOptInEventTypes"]
        ),
        enabled_logging_strategies=["enabledLoggingStrategies"],
        manifest_service_interaction_log=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.ManifestServiceInteractionLogProperty(
            exclude_event_types=["excludeEventTypes"]
        ),
        percent_enabled=123
    ),
    manifest_processing_rules=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.ManifestProcessingRulesProperty(
        ad_marker_passthrough=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AdMarkerPassthroughProperty(
            enabled=False
        )
    ),
    name="name",
    personalization_threshold_seconds=123,
    slate_ad_url="slateAdUrl",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    transcode_profile_name="transcodeProfileName",
    video_content_source_url="videoContentSourceUrl"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::MediaTailor::PlaybackConfiguration.

Parameters:

props (Union[CfnPlaybackConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['adConditioningConfiguration', 'adDecisionServerUrl', 'availSuppression', 'bumper', 'cdnConfiguration', 'configurationAliases', 'dashConfiguration', 'hlsConfiguration', 'insertionMode', 'livePreRollConfiguration', 'logConfiguration', 'manifestProcessingRules', 'name', 'personalizationThresholdSeconds', 'slateAdUrl', 'tags', 'transcodeProfileName', 'videoContentSourceUrl']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AdConditioningConfigurationProperty

class CfnPlaybackConfigurationPropsMixin.AdConditioningConfigurationProperty(*, streaming_media_file_conditioning=None)

Bases: object

The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns.

Parameters:: streaming_media_file_conditioning (Optional[str]) – For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. TRANSCODE indicates that MediaTailor must transcode the ads. NONE indicates that you have already transcoded the ads outside of MediaTailor and don’t need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see Using preconditioned ads in the AWS Elemental MediaTailor user guide.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adconditioningconfiguration.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

ad_conditioning_configuration_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AdConditioningConfigurationProperty(
    streaming_media_file_conditioning="streamingMediaFileConditioning"
)

Attributes

streaming_media_file_conditioning

For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS.

TRANSCODE indicates that MediaTailor must transcode the ads. NONE indicates that you have already transcoded the ads outside of MediaTailor and don’t need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see Using preconditioned ads in the AWS Elemental MediaTailor user guide.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adconditioningconfiguration.html#cfn-mediatailor-playbackconfiguration-adconditioningconfiguration-streamingmediafileconditioning

AdMarkerPassthroughProperty

class CfnPlaybackConfigurationPropsMixin.AdMarkerPassthroughProperty(*, enabled=None)

Bases: object

For HLS, when set to true , MediaTailor passes through EXT-X-CUE-IN , EXT-X-CUE-OUT , and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.

No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60 , but no ads are filled for that ad break, MediaTailor will not set the value to 0 .

Parameters:: enabled (Union[bool, IResolvable, None]) – Enables ad marker passthrough for your configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

ad_marker_passthrough_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AdMarkerPassthroughProperty(
    enabled=False
)

Attributes

enabled

Enables ad marker passthrough for your configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.html#cfn-mediatailor-playbackconfiguration-admarkerpassthrough-enabled

AdsInteractionLogProperty

class CfnPlaybackConfigurationPropsMixin.AdsInteractionLogProperty(*, exclude_event_types=None, publish_opt_in_event_types=None)

Bases: object

Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).

For more information about ADS logs, inlcuding descriptions of the event types, see MediaTailor ADS logs description and event types in AWS Elemental MediaTailor User Guide.

Parameters:

exclude_event_types (Optional[Sequence[str]]) – Indicates that MediaTailor won’t emit the selected events in the logs for playback sessions that are initialized with this configuration.
publish_opt_in_event_types (Optional[Sequence[str]]) – Indicates that MediaTailor emits RAW_ADS_RESPONSE logs for playback sessions that are initialized with this configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

ads_interaction_log_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AdsInteractionLogProperty(
    exclude_event_types=["excludeEventTypes"],
    publish_opt_in_event_types=["publishOptInEventTypes"]
)

Attributes

exclude_event_types

Indicates that MediaTailor won’t emit the selected events in the logs for playback sessions that are initialized with this configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html#cfn-mediatailor-playbackconfiguration-adsinteractionlog-excludeeventtypes

publish_opt_in_event_types

Indicates that MediaTailor emits RAW_ADS_RESPONSE logs for playback sessions that are initialized with this configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html#cfn-mediatailor-playbackconfiguration-adsinteractionlog-publishoptineventtypes

AvailSuppressionProperty

class CfnPlaybackConfigurationPropsMixin.AvailSuppressionProperty(*, fill_policy=None, mode=None, value=None)

Bases: object

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

For more information about ad suppression, see Ad Suppression .

Parameters:

fill_policy (Optional[str]) – Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.
mode (Optional[str]) – Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE , ad suppression is active and MediaTailor won’t fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE , ad suppression is active and MediaTailor won’t fill ad breaks that are within the live edge plus the avail suppression value.
value (Optional[str]) – A live edge offset time in HH:MM:SS. MediaTailor won’t fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won’t fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won’t fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won’t fill ad breaks on or behind 45 minutes behind the live edge.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

avail_suppression_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AvailSuppressionProperty(
    fill_policy="fillPolicy",
    mode="mode",
    value="value"
)

Attributes

fill_policy

Defines the policy to apply to the avail suppression mode.

BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.

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

mode

Sets the ad suppression mode.

By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE , ad suppression is active and MediaTailor won’t fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE , ad suppression is active and MediaTailor won’t fill ad breaks that are within the live edge plus the avail suppression value.

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

value

SS.

MediaTailor won’t fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won’t fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won’t fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won’t fill ad breaks on or behind 45 minutes behind the live edge.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-value
Type:: A live edge offset time in HH
Type:: MM

BumperProperty

class CfnPlaybackConfigurationPropsMixin.BumperProperty(*, end_url=None, start_url=None)

Bases: object

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 .

Parameters:

end_url (Optional[str]) – The URL for the end bumper asset.
start_url (Optional[str]) – The URL for the start bumper asset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

bumper_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.BumperProperty(
    end_url="endUrl",
    start_url="startUrl"
)

Attributes

end_url

The URL for the end bumper asset.

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

start_url

The URL for the start bumper asset.

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

CdnConfigurationProperty

class CfnPlaybackConfigurationPropsMixin.CdnConfigurationProperty(*, ad_segment_url_prefix=None, content_segment_url_prefix=None)

Bases: object

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

Parameters:

ad_segment_url_prefix (Optional[str]) – A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor. ** .amazonaws.com. Then specify the rule’s name in this AdSegmentUrlPrefix . When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
content_segment_url_prefix (Optional[str]) – A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule’s name in this ContentSegmentUrlPrefix . When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

cdn_configuration_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.CdnConfigurationProperty(
    ad_segment_url_prefix="adSegmentUrlPrefix",
    content_segment_url_prefix="contentSegmentUrlPrefix"
)

Attributes

ad_segment_url_prefix

A non-default content delivery network (CDN) to serve ad segments.

By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor. ** .amazonaws.com. Then specify the rule’s name in this AdSegmentUrlPrefix . When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

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

content_segment_url_prefix

A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server.

First, create a rule in your CDN for the content segment origin server. Then specify the rule’s name in this ContentSegmentUrlPrefix . When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

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

DashConfigurationProperty

class CfnPlaybackConfigurationPropsMixin.DashConfigurationProperty(*, manifest_endpoint_prefix=None, mpd_location=None, origin_manifest_type=None)

Bases: object

The configuration for DASH content.

Parameters:

manifest_endpoint_prefix (Optional[str]) – The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
mpd_location (Optional[str]) – The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don’t support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT . The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
origin_manifest_type (Optional[str]) – The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD . The default setting is MULTI_PERIOD . For multi-period manifests, omit this setting or set it to MULTI_PERIOD .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

dash_configuration_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.DashConfigurationProperty(
    manifest_endpoint_prefix="manifestEndpointPrefix",
    mpd_location="mpdLocation",
    origin_manifest_type="originManifestType"
)

Attributes

manifest_endpoint_prefix

The URL generated by MediaTailor to initiate a playback session.

The session uses server-side reporting. This setting is ignored in PUT operations.

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

mpd_location

The setting that controls whether MediaTailor includes the Location tag in DASH manifests.

MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don’t support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT . The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

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

origin_manifest_type

The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests.

If your origin server produces single-period manifests, set this to SINGLE_PERIOD . The default setting is MULTI_PERIOD . For multi-period manifests, omit this setting or set it to MULTI_PERIOD .

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

HlsConfigurationProperty

class CfnPlaybackConfigurationPropsMixin.HlsConfigurationProperty(*, manifest_endpoint_prefix=None)

Bases: object

The configuration for HLS content.

Parameters:: manifest_endpoint_prefix (Optional[str]) – The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-hlsconfiguration.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

hls_configuration_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.HlsConfigurationProperty(
    manifest_endpoint_prefix="manifestEndpointPrefix"
)

Attributes

manifest_endpoint_prefix

The URL that is used to initiate a playback session for devices that support Apple HLS.

The session uses server-side reporting.

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

LivePreRollConfigurationProperty

class CfnPlaybackConfigurationPropsMixin.LivePreRollConfigurationProperty(*, ad_decision_server_url=None, max_duration_seconds=None)

Bases: object

The configuration for pre-roll ad insertion.

Parameters:

ad_decision_server_url (Optional[str]) – The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental 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.
max_duration_seconds (Union[int, float, None]) – The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won’t play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

live_pre_roll_configuration_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.LivePreRollConfigurationProperty(
    ad_decision_server_url="adDecisionServerUrl",
    max_duration_seconds=123
)

Attributes

ad_decision_server_url

The URL for the ad decision server (ADS) for pre-roll ads.

This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental 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.

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

max_duration_seconds

The maximum allowed duration for the pre-roll ad avail.

AWS Elemental MediaTailor won’t play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.

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

LogConfigurationProperty

class CfnPlaybackConfigurationPropsMixin.LogConfigurationProperty(*, ads_interaction_log=None, enabled_logging_strategies=None, manifest_service_interaction_log=None, percent_enabled=None)

Bases: object

Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

Parameters:

ads_interaction_log (Union[IResolvable, AdsInteractionLogProperty, Dict[str, Any], None]) – Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).
enabled_logging_strategies (Optional[Sequence[str]]) – The method used for collecting logs from AWS Elemental MediaTailor. LEGACY_CLOUDWATCH indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. VENDED_LOGS indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.
manifest_service_interaction_log (Union[IResolvable, ManifestServiceInteractionLogProperty, Dict[str, Any], None]) – Settings for customizing what events are included in logs for interactions with the origin server.
percent_enabled (Union[int, float, None]) – The percentage of session logs that MediaTailor sends to your configured log destination. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60 , MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode . Valid values: 0 - 100

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

log_configuration_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.LogConfigurationProperty(
    ads_interaction_log=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AdsInteractionLogProperty(
        exclude_event_types=["excludeEventTypes"],
        publish_opt_in_event_types=["publishOptInEventTypes"]
    ),
    enabled_logging_strategies=["enabledLoggingStrategies"],
    manifest_service_interaction_log=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.ManifestServiceInteractionLogProperty(
        exclude_event_types=["excludeEventTypes"]
    ),
    percent_enabled=123
)

Attributes

ads_interaction_log

Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-adsinteractionlog

enabled_logging_strategies

The method used for collecting logs from AWS Elemental MediaTailor.

LEGACY_CLOUDWATCH indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. VENDED_LOGS indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-enabledloggingstrategies

manifest_service_interaction_log

Settings for customizing what events are included in logs for interactions with the origin server.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-manifestserviceinteractionlog

percent_enabled

The percentage of session logs that MediaTailor sends to your configured log destination.

For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60 , MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode .

Valid values: 0 - 100

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-percentenabled

ManifestProcessingRulesProperty

class CfnPlaybackConfigurationPropsMixin.ManifestProcessingRulesProperty(*, ad_marker_passthrough=None)

Bases: object

The configuration for manifest processing rules.

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

Parameters:: ad_marker_passthrough (Union[IResolvable, AdMarkerPassthroughProperty, Dict[str, Any], None]) – For HLS, when set to true , MediaTailor passes through EXT-X-CUE-IN , EXT-X-CUE-OUT , and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest. No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60 , but no ads are filled for that ad break, MediaTailor will not set the value to 0 .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestprocessingrules.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

manifest_processing_rules_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.ManifestProcessingRulesProperty(
    ad_marker_passthrough=mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.AdMarkerPassthroughProperty(
        enabled=False
    )
)

Attributes

ad_marker_passthrough

For HLS, when set to true , MediaTailor passes through EXT-X-CUE-IN , EXT-X-CUE-OUT , and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.

No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60 , but no ads are filled for that ad break, MediaTailor will not set the value to 0 .

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

ManifestServiceInteractionLogProperty

class CfnPlaybackConfigurationPropsMixin.ManifestServiceInteractionLogProperty(*, exclude_event_types=None)

Bases: object

Settings for customizing what events are included in logs for interactions with the origin server.

For more information about manifest service logs, including descriptions of the event types, see MediaTailor manifest logs description and event types in AWS Elemental MediaTailor User Guide.

Parameters:: exclude_event_types (Optional[Sequence[str]]) – Indicates that MediaTailor won’t emit the selected events in the logs for playback sessions that are initialized with this configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestserviceinteractionlog.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.mixins_preview.aws_mediatailor import mixins as mediatailor_mixins

manifest_service_interaction_log_property = mediatailor_mixins.CfnPlaybackConfigurationPropsMixin.ManifestServiceInteractionLogProperty(
    exclude_event_types=["excludeEventTypes"]
)

Attributes

exclude_event_types

Indicates that MediaTailor won’t emit the selected events in the logs for playback sessions that are initialized with this configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestserviceinteractionlog.html#cfn-mediatailor-playbackconfiguration-manifestserviceinteractionlog-excludeeventtypes