Class: Aws::MediaTailor::Types::PrefetchSchedule

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

Overview

A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see [Using ad prefetching] in the *MediaTailor User Guide*.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the prefetch schedule.

Returns:

  • (String) 


3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3551

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#consumption ⇒ Types::PrefetchConsumption

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. Ad consumption occurs within a span of time that you define, called a *consumption window*. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

Returns:



3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3551

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

Returns:

  • (String) 


3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3551

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#playback_configuration_name ⇒ String

The name of the playback configuration to create the prefetch schedule for.

Returns:

  • (String) 


3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3551

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#recurring_prefetch_configuration ⇒ Types::RecurringPrefetchConfiguration

The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.

Returns:



3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3551

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#retrieval ⇒ Types::PrefetchRetrieval

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

Returns:



3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3551

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_type ⇒ String

The frequency that MediaTailor creates prefetch schedules. ‘SINGLE` indicates that this schedule applies to one ad break. `RECURRING` indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

For more information about the prefetch types and when you might use each, see [Prefetching ads in Elemental MediaTailor.]

[1]: docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html

Returns:

  • (String) 


3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3551

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_id ⇒ String

An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

Returns:

  • (String) 


3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3551

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end