Class: Aws::MediaTailor::Types::PutPlaybackConfigurationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb

Overview

Note:

When making an API call, you may pass PutPlaybackConfigurationRequest data as a hash:

{
  ad_decision_server_url: "__string",
  avail_suppression: {
    mode: "OFF", # accepts OFF, BEHIND_LIVE_EDGE
    value: "__string",
  },
  bumper: {
    end_url: "__string",
    start_url: "__string",
  },
  cdn_configuration: {
    ad_segment_url_prefix: "__string",
    content_segment_url_prefix: "__string",
  },
  personalization_threshold_seconds: 1,
  dash_configuration: {
    mpd_location: "__string",
    origin_manifest_type: "SINGLE_PERIOD", # accepts SINGLE_PERIOD, MULTI_PERIOD
  },
  live_pre_roll_configuration: {
    ad_decision_server_url: "__string",
    max_duration_seconds: 1,
  },
  name: "__string",
  slate_ad_url: "__string",
  tags: {
    "__string" => "__string",
  },
  transcode_profile_name: "__string",
  video_content_source_url: "__string",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ad_decision_server_urlString

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.

Returns:

  • (String)


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#avail_suppressionTypes::AvailSuppression

The configuration for Avail Suppression.



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#bumperTypes::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.

Returns:



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#cdn_configurationTypes::CdnConfiguration

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



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#dash_configurationTypes::DashConfigurationForPut

The configuration for DASH content.



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#live_pre_roll_configurationTypes::LivePreRollConfiguration

The configuration for pre-roll ad insertion.



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The identifier for the playback configuration.

Returns:

  • (String)


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#personalization_threshold_secondsInteger

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

Returns:

  • (Integer)


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#slate_ad_urlString

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.

Returns:

  • (String)


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags to assign to the playback configuration.

Returns:

  • (Hash<String,String>)


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#transcode_profile_nameString

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.

Returns:

  • (String)


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#video_content_source_urlString

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

Returns:

  • (String)


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 634

class PutPlaybackConfigurationRequest < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :personalization_threshold_seconds,
  :dash_configuration,
  :live_pre_roll_configuration,
  :name,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end