Package software.amazon.awscdk.services.mediatailor

Interface CfnPlaybackConfiguration.AvailSuppressionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlaybackConfiguration.AvailSuppressionProperty.Jsii$Proxy

Enclosing class:

CfnPlaybackConfiguration

@Stability(Stable)
public static interface CfnPlaybackConfiguration.AvailSuppressionProperty
extends software.amazon.jsii.JsiiSerializable

The configuration for avail suppression, also known as ad suppression.

For more information about ad suppression, see Ad Suppression .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediatailor.*;
 AvailSuppressionProperty availSuppressionProperty = AvailSuppressionProperty.builder()
         .fillPolicy("fillPolicy")
         .mode("mode")
         .value("value")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlaybackConfiguration.AvailSuppressionProperty.Builder	A builder for CfnPlaybackConfiguration.AvailSuppressionProperty
static final class	CfnPlaybackConfiguration.AvailSuppressionProperty.Jsii$Proxy	An implementation for CfnPlaybackConfiguration.AvailSuppressionProperty

Method Summary

Modifier and Type	Method	Description
static CfnPlaybackConfiguration.AvailSuppressionProperty.Builder	builder()
default String	getFillPolicy()	Defines the policy to apply to the avail suppression mode.
default String	getMode()	Sets the ad suppression mode.
default String	getValue()	A live edge offset time in HH:MM:SS.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFillPolicy

@Stability(Stable)
@Nullable
default String getFillPolicy()

Defines the policy to apply to the avail suppression mode.

BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-fillpolicy

getMode

@Stability(Stable)
@Nullable
default String getMode()

Sets the ad suppression mode.

By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE , ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE , ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-mode

getValue

@Stability(Stable)
@Nullable
default String getValue()

A live edge offset time in HH:MM:SS.

MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-value

builder

@Stability(Stable)
static CfnPlaybackConfiguration.AvailSuppressionProperty.Builder builder()

Returns:

a CfnPlaybackConfiguration.AvailSuppressionProperty.Builder of CfnPlaybackConfiguration.AvailSuppressionProperty