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

Inherits:

Struct

Object
Struct
Aws::MediaTailor::Types::PutPlaybackConfigurationRequest

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",
  },
  configuration_aliases: {
    "__string" => {
      "__string" => "__string",
    },
  },
  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,
  },
  manifest_processing_rules: {
    ad_marker_passthrough: {
      enabled: false,
    },
  },
  name: "__string",
  personalization_threshold_seconds: 1,
  slate_ad_url: "__string",
  tags: {
    "__string" => "__string",
  },
  transcode_profile_name: "__string",
  video_content_source_url: "__string",
}

The configuration for creating a playback configuration.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#ad_decision_server_url ⇒ String
The URL for the ad decision server (ADS).
#avail_suppression ⇒ Types::AvailSuppression
The configuration for avail suppression, also known as ad suppression.
#bumper ⇒ Types::Bumper
The configuration for bumpers.
#cdn_configuration ⇒ Types::CdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
#configuration_aliases ⇒ Hash<String,Hash<String,String>>
The player parameters and aliases used as dynamic variables during session initialization.
#dash_configuration ⇒ Types::DashConfigurationForPut
The configuration for DASH content.
#live_pre_roll_configuration ⇒ Types::LivePreRollConfiguration
The configuration for pre-roll ad insertion.
#manifest_processing_rules ⇒ Types::ManifestProcessingRules
The configuration for manifest processing rules.
#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.
#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.
#tags ⇒ Hash<String,String>
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.
#video_content_source_url ⇒ String
The URL prefix for the parent manifest for the stream, minus the asset ID.

Instance Attribute Details

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

Returns:

(String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

#avail_suppression ⇒ `Types::AvailSuppression`

The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

Returns:

(Types::AvailSuppression)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

#bumper ⇒ `Types::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.

Returns:

(Types::Bumper)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

#cdn_configuration ⇒ `Types::CdnConfiguration`

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

Returns:

(Types::CdnConfiguration)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

#configuration_aliases ⇒ `Hash<String,Hash<String,String>>`

The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

Returns:

(Hash<String,Hash<String,String>>)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

#dash_configuration ⇒ `Types::DashConfigurationForPut`

The configuration for DASH content.

Returns:

(Types::DashConfigurationForPut)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

#live_pre_roll_configuration ⇒ `Types::LivePreRollConfiguration`

The configuration for pre-roll ad insertion.

Returns:

(Types::LivePreRollConfiguration)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

#manifest_processing_rules ⇒ `Types::ManifestProcessingRules`

The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Returns:

(Types::ManifestProcessingRules)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

#name ⇒ `String`

The identifier for the playback configuration.

Returns:

(String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

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

Returns:

(Integer)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

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

Returns:

(String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

#tags ⇒ `Hash<String,String>`

The tags to assign to the playback configuration.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

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

Returns:

(String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

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

Returns:

(String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3291

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#ad_decision_server_url ⇒ String

#avail_suppression ⇒ Types::AvailSuppression

#bumper ⇒ Types::Bumper

#cdn_configuration ⇒ Types::CdnConfiguration

#configuration_aliases ⇒ Hash<String,Hash<String,String>>

#dash_configuration ⇒ Types::DashConfigurationForPut

#live_pre_roll_configuration ⇒ Types::LivePreRollConfiguration

#manifest_processing_rules ⇒ Types::ManifestProcessingRules

#name ⇒ String

#personalization_threshold_seconds ⇒ Integer

#slate_ad_url ⇒ String

#tags ⇒ Hash<String,String>

#transcode_profile_name ⇒ String

#video_content_source_url ⇒ String

#ad_decision_server_url ⇒ `String`

#avail_suppression ⇒ `Types::AvailSuppression`

#bumper ⇒ `Types::Bumper`

#cdn_configuration ⇒ `Types::CdnConfiguration`

#configuration_aliases ⇒ `Hash<String,Hash<String,String>>`

#dash_configuration ⇒ `Types::DashConfigurationForPut`

#live_pre_roll_configuration ⇒ `Types::LivePreRollConfiguration`

#manifest_processing_rules ⇒ `Types::ManifestProcessingRules`

#name ⇒ `String`

#personalization_threshold_seconds ⇒ `Integer`

#slate_ad_url ⇒ `String`

#tags ⇒ `Hash<String,String>`

#transcode_profile_name ⇒ `String`

#video_content_source_url ⇒ `String`