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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediatailor/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.

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) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3191

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

#consumption ⇒ Types::PrefetchConsumption

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. 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:



3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3191

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :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) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3191

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :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) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3191

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :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:



3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3191

class PrefetchSchedule < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :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) 


3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3191

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