playback_configurations

Creates, updates, deletes or gets a playback_configuration resource or lists playback_configurations in a region

Overview

Name	playback_configurations
Type	Resource
Description	Resource schema for AWS::MediaTailor::PlaybackConfiguration
Id	awscc.mediatailor.playback_configurations

Fields

get (all properties)

Name	Datatype	Description
▶ad_conditioning_configuration	object	<p>The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns.</p>
ad_decision_server_url	string	The URL for the ad decision server (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.
▶avail_suppression	object	The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
▶bumper	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 (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).
▶cdn_configuration	object	The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
configuration_aliases	object	The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
▶dash_configuration	object	The configuration for DASH content.
insertion_mode	string	The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED&#95;ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER&#95;SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
▶live_pre_roll_configuration	object	The configuration for pre-roll ad insertion.
▶manifest_processing_rules	object	The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
name	string	The identifier for the playback configuration.
personalization_threshold_seconds	integer	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 AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
session_initialization_endpoint_prefix	string	The URL that the player uses to initialize a session that uses client-side reporting.
▶hls_configuration	object	The configuration for HLS content.
▶log_configuration	object	The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.
playback_configuration_arn	string	The Amazon Resource Name (ARN) for the playback configuration.
playback_endpoint_prefix	string	The URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.
slate_ad_url	string	The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental 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	array	The tags to assign to the playback configuration.
transcode_profile_name	string	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.
video_content_source_url	string	The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The identifier for the playback configuration.
region	string	AWS region.

For more information, see AWS::MediaTailor::PlaybackConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	playback_configurations	INSERT	Name, VideoContentSourceUrl, AdDecisionServerUrl, region
delete_resource	playback_configurations	DELETE	Identifier, region
update_resource	playback_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	playback_configurations_list_only	SELECT	region
get_resource	playback_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual playback_configuration.

SELECT
  region,
  ad_conditioning_configuration,
  ad_decision_server_url,
  avail_suppression,
  bumper,
  cdn_configuration,
  configuration_aliases,
  dash_configuration,
  insertion_mode,
  live_pre_roll_configuration,
  manifest_processing_rules,
  name,
  personalization_threshold_seconds,
  session_initialization_endpoint_prefix,
  hls_configuration,
  log_configuration,
  playback_configuration_arn,
  playback_endpoint_prefix,
  slate_ad_url,
  tags,
  transcode_profile_name,
  video_content_source_url
FROM awscc.mediatailor.playback_configurations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all playback_configurations in a region.

SELECT
  region,
  name
FROM awscc.mediatailor.playback_configurations_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new playback_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.mediatailor.playback_configurations (
  AdDecisionServerUrl,
  Name,
  VideoContentSourceUrl,
  region
)
SELECT
  '{{ ad_decision_server_url }}',
  '{{ name }}',
  '{{ video_content_source_url }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.mediatailor.playback_configurations (
  AdConditioningConfiguration,
  AdDecisionServerUrl,
  AvailSuppression,
  Bumper,
  CdnConfiguration,
  ConfigurationAliases,
  DashConfiguration,
  InsertionMode,
  LivePreRollConfiguration,
  ManifestProcessingRules,
  Name,
  PersonalizationThresholdSeconds,
  HlsConfiguration,
  LogConfiguration,
  SlateAdUrl,
  Tags,
  TranscodeProfileName,
  VideoContentSourceUrl,
  region
)
SELECT
  '{{ ad_conditioning_configuration }}',
  '{{ ad_decision_server_url }}',
  '{{ avail_suppression }}',
  '{{ bumper }}',
  '{{ cdn_configuration }}',
  '{{ configuration_aliases }}',
  '{{ dash_configuration }}',
  '{{ insertion_mode }}',
  '{{ live_pre_roll_configuration }}',
  '{{ manifest_processing_rules }}',
  '{{ name }}',
  '{{ personalization_threshold_seconds }}',
  '{{ hls_configuration }}',
  '{{ log_configuration }}',
  '{{ slate_ad_url }}',
  '{{ tags }}',
  '{{ transcode_profile_name }}',
  '{{ video_content_source_url }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: playback_configuration
    props:
      - name: ad_conditioning_configuration
        value:
          streaming_media_file_conditioning: '{{ streaming_media_file_conditioning }}'
      - name: ad_decision_server_url
        value: '{{ ad_decision_server_url }}'
      - name: avail_suppression
        value:
          mode: '{{ mode }}'
          value: '{{ value }}'
          fill_policy: '{{ fill_policy }}'
      - name: bumper
        value:
          start_url: '{{ start_url }}'
          end_url: '{{ end_url }}'
      - name: cdn_configuration
        value:
          ad_segment_url_prefix: '{{ ad_segment_url_prefix }}'
          content_segment_url_prefix: '{{ content_segment_url_prefix }}'
      - name: configuration_aliases
        value: null
      - name: dash_configuration
        value:
          mpd_location: '{{ mpd_location }}'
          origin_manifest_type: '{{ origin_manifest_type }}'
          manifest_endpoint_prefix: '{{ manifest_endpoint_prefix }}'
      - name: insertion_mode
        value: '{{ insertion_mode }}'
      - name: live_pre_roll_configuration
        value:
          ad_decision_server_url: '{{ ad_decision_server_url }}'
          max_duration_seconds: '{{ max_duration_seconds }}'
      - name: manifest_processing_rules
        value:
          ad_marker_passthrough:
            enabled: '{{ enabled }}'
      - name: name
        value: '{{ name }}'
      - name: personalization_threshold_seconds
        value: '{{ personalization_threshold_seconds }}'
      - name: hls_configuration
        value:
          manifest_endpoint_prefix: '{{ manifest_endpoint_prefix }}'
      - name: log_configuration
        value:
          ads_interaction_log:
            exclude_event_types:
              - '{{ exclude_event_types[0] }}'
            publish_opt_in_event_types:
              - '{{ publish_opt_in_event_types[0] }}'
          enabled_logging_strategies:
            - '{{ enabled_logging_strategies[0] }}'
          manifest_service_interaction_log:
            exclude_event_types:
              - '{{ exclude_event_types[0] }}'
          percent_enabled: '{{ percent_enabled }}'
      - name: slate_ad_url
        value: '{{ slate_ad_url }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: transcode_profile_name
        value: '{{ transcode_profile_name }}'
      - name: video_content_source_url
        value: '{{ video_content_source_url }}'

UPDATE example

Use the following StackQL query and manifest file to update a playback_configuration resource, using stack-deploy.

/*+ update */
UPDATE awscc.mediatailor.playback_configurations
SET PatchDocument = string('{{ {
    "AdConditioningConfiguration": ad_conditioning_configuration,
    "AdDecisionServerUrl": ad_decision_server_url,
    "AvailSuppression": avail_suppression,
    "Bumper": bumper,
    "CdnConfiguration": cdn_configuration,
    "ConfigurationAliases": configuration_aliases,
    "InsertionMode": insertion_mode,
    "LivePreRollConfiguration": live_pre_roll_configuration,
    "ManifestProcessingRules": manifest_processing_rules,
    "PersonalizationThresholdSeconds": personalization_threshold_seconds,
    "LogConfiguration": log_configuration,
    "SlateAdUrl": slate_ad_url,
    "Tags": tags,
    "TranscodeProfileName": transcode_profile_name,
    "VideoContentSourceUrl": video_content_source_url
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.mediatailor.playback_configurations
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1';

Permissions

To operate on the playback_configurations resource, the following permissions are required:

Create

mediatailor:PutPlaybackConfiguration,
mediatailor:ConfigureLogsForPlaybackConfiguration,
iam:CreateServiceLinkedRole,
mediatailor:UntagResource,
mediatailor:TagResource

Read

mediatailor:GetPlaybackConfiguration

Update

mediatailor:PutPlaybackConfiguration,
mediatailor:ConfigureLogsForPlaybackConfiguration,
iam:CreateServiceLinkedRole,
mediatailor:UntagResource,
mediatailor:TagResource

Delete

mediatailor:DeletePlaybackConfiguration

List

mediatailor:ListPlaybackConfigurations