import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { ChannelPolicyReference, ChannelReference, FunctionReference, IChannelPolicyRef, IChannelRef, IFunctionRef, ILiveSourceRef, IPlaybackConfigurationRef, IPrefetchScheduleRef, IProgramRef, ISourceLocationRef, IVodSourceRef, LiveSourceReference, PlaybackConfigurationReference, PrefetchScheduleReference, ProgramReference, SourceLocationReference, VodSourceReference } from "../../interfaces/generated/aws-mediatailor-interfaces.generated"; /** * The configuration parameters for a channel. * * For information about MediaTailor channels, see [Working with channels](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) in the *MediaTailor User Guide* . * * @cloudformationResource AWS::MediaTailor::Channel * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html */ export declare class CfnChannel extends cdk.CfnResource implements cdk.IInspectable, IChannelRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnChannel from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnChannel; /** * Checks whether the given object is a CfnChannel */ static isCfnChannel(x: any): x is CfnChannel; /** * Creates a new IChannelRef from an ARN */ static fromChannelArn(scope: constructs.Construct, id: string, arn: string): IChannelRef; /** * Creates a new IChannelRef from a channelName */ static fromChannelName(scope: constructs.Construct, id: string, channelName: string): IChannelRef; static arnForChannel(resource: IChannelRef): string; /** * The list of audiences defined in channel. */ private _audiences?; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The name of the channel. */ private _channelName; /** * The slate used to fill gaps between programs in the schedule. */ private _fillerSlate?; /** * The log configuration. */ private _logConfiguration?; /** * The channel's output properties. */ private _outputs; /** * The type of playback mode for this channel. */ private _playbackMode; /** * The tags to assign to the channel. */ private _tags?; /** * The tier for this channel. */ private _tier?; /** * The configuration for time-shifted viewing. */ private _timeShiftConfiguration?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::MediaTailor::Channel`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnChannelProps); get channelRef(): ChannelReference; /** * The list of audiences defined in channel. */ get audiences(): Array | undefined; /** * The list of audiences defined in channel. */ set audiences(value: Array | undefined); /** * The name of the channel. */ get channelName(): string; /** * The name of the channel. */ set channelName(value: string); /** * The slate used to fill gaps between programs in the schedule. */ get fillerSlate(): cdk.IResolvable | CfnChannel.SlateSourceProperty | undefined; /** * The slate used to fill gaps between programs in the schedule. */ set fillerSlate(value: cdk.IResolvable | CfnChannel.SlateSourceProperty | undefined); /** * The log configuration. */ get logConfiguration(): cdk.IResolvable | CfnChannel.LogConfigurationForChannelProperty | undefined; /** * The log configuration. */ set logConfiguration(value: cdk.IResolvable | CfnChannel.LogConfigurationForChannelProperty | undefined); /** * The channel's output properties. */ get outputs(): Array | cdk.IResolvable; /** * The channel's output properties. */ set outputs(value: Array | cdk.IResolvable); /** * The type of playback mode for this channel. */ get playbackMode(): string; /** * The type of playback mode for this channel. */ set playbackMode(value: string); /** * The tags to assign to the channel. */ get tags(): Array | undefined; /** * The tags to assign to the channel. */ set tags(value: Array | undefined); /** * The tier for this channel. */ get tier(): string | undefined; /** * The tier for this channel. */ set tier(value: string | undefined); /** * The configuration for time-shifted viewing. */ get timeShiftConfiguration(): cdk.IResolvable | CfnChannel.TimeShiftConfigurationProperty | undefined; /** * The configuration for time-shifted viewing. */ set timeShiftConfiguration(value: cdk.IResolvable | CfnChannel.TimeShiftConfigurationProperty | undefined); /** *

The ARN of the channel.

* * @cloudformationAttribute Arn */ get attrArn(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnChannel { /** * Slate VOD source configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html */ interface SlateSourceProperty { /** * The name of the source location where the slate VOD source is stored. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html#cfn-mediatailor-channel-slatesource-sourcelocationname */ readonly sourceLocationName?: string; /** * The slate VOD source name. * * The VOD source must already exist in a source location before it can be used for slate. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-slatesource.html#cfn-mediatailor-channel-slatesource-vodsourcename */ readonly vodSourceName?: string; } /** * The output configuration for this channel. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html */ interface RequestOutputItemProperty { /** * DASH manifest configuration parameters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-dashplaylistsettings */ readonly dashPlaylistSettings?: CfnChannel.DashPlaylistSettingsProperty | cdk.IResolvable; /** * HLS playlist configuration parameters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-hlsplaylistsettings */ readonly hlsPlaylistSettings?: CfnChannel.HlsPlaylistSettingsProperty | cdk.IResolvable; /** * The name of the manifest for the channel. * * The name appears in the `PlaybackUrl` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-manifestname */ readonly manifestName: string; /** * A string used to match which `HttpPackageConfiguration` is used for each `VodSource` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-requestoutputitem.html#cfn-mediatailor-channel-requestoutputitem-sourcegroup */ readonly sourceGroup: string; } /** * Dash manifest configuration parameters. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html */ interface DashPlaylistSettingsProperty { /** * The total duration (in seconds) of each manifest. * * Minimum value: `30` seconds. Maximum value: `3600` seconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-manifestwindowseconds */ readonly manifestWindowSeconds?: number; /** * Minimum amount of content (measured in seconds) that a player must keep available in the buffer. * * Minimum value: `2` seconds. Maximum value: `60` seconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minbuffertimeseconds */ readonly minBufferTimeSeconds?: number; /** * Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. * * Minimum value: `2` seconds. Maximum value: `60` seconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-minupdateperiodseconds */ readonly minUpdatePeriodSeconds?: number; /** * Amount of time (in seconds) that the player should be from the live point at the end of the manifest. * * Minimum value: `2` seconds. Maximum value: `60` seconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-dashplaylistsettings.html#cfn-mediatailor-channel-dashplaylistsettings-suggestedpresentationdelayseconds */ readonly suggestedPresentationDelaySeconds?: number; } /** * HLS playlist configuration parameters. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html */ interface HlsPlaylistSettingsProperty { /** * Determines the type of SCTE 35 tags to use in ad markup. * * Specify `DATERANGE` to use `DATERANGE` tags (for live or VOD content). Specify `SCTE35_ENHANCED` to use `EXT-X-CUE-OUT` and `EXT-X-CUE-IN` tags (for VOD content only). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html#cfn-mediatailor-channel-hlsplaylistsettings-admarkuptype */ readonly adMarkupType?: Array; /** * The total duration (in seconds) of each manifest. * * Minimum value: `30` seconds. Maximum value: `3600` seconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-hlsplaylistsettings.html#cfn-mediatailor-channel-hlsplaylistsettings-manifestwindowseconds */ readonly manifestWindowSeconds?: number; } /** * The log configuration for the channel. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-logconfigurationforchannel.html */ interface LogConfigurationForChannelProperty { /** * The log types. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-logconfigurationforchannel.html#cfn-mediatailor-channel-logconfigurationforchannel-logtypes */ readonly logTypes?: Array; } /** * The configuration for time-shifted viewing. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-timeshiftconfiguration.html */ interface TimeShiftConfigurationProperty { /** * The maximum time delay for time-shifted viewing. * * The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-channel-timeshiftconfiguration.html#cfn-mediatailor-channel-timeshiftconfiguration-maxtimedelayseconds */ readonly maxTimeDelaySeconds: number; } } /** * Properties for defining a `CfnChannel` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html */ export interface CfnChannelProps { /** * The list of audiences defined in channel. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-audiences */ readonly audiences?: Array; /** * The name of the channel. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-channelname */ readonly channelName: string; /** * The slate used to fill gaps between programs in the schedule. * * You must configure filler slate if your channel uses the `LINEAR` `PlaybackMode` . MediaTailor doesn't support filler slate for channels using the `LOOP` `PlaybackMode` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-fillerslate */ readonly fillerSlate?: cdk.IResolvable | CfnChannel.SlateSourceProperty; /** * The log configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-logconfiguration */ readonly logConfiguration?: cdk.IResolvable | CfnChannel.LogConfigurationForChannelProperty; /** * The channel's output properties. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-outputs */ readonly outputs: Array | cdk.IResolvable; /** * The type of playback mode for this channel. * * `LINEAR` - Programs play back-to-back only once. * * `LOOP` - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-playbackmode */ readonly playbackMode: string; /** * The tags to assign to the channel. * * Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-tags */ readonly tags?: Array; /** * The tier for this channel. * * STANDARD tier channels can contain live programs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-tier */ readonly tier?: string; /** * The configuration for time-shifted viewing. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channel.html#cfn-mediatailor-channel-timeshiftconfiguration */ readonly timeShiftConfiguration?: cdk.IResolvable | CfnChannel.TimeShiftConfigurationProperty; } /** * Specifies an IAM policy for the channel. * * IAM policies are used to control access to your channel. * * @cloudformationResource AWS::MediaTailor::ChannelPolicy * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channelpolicy.html */ export declare class CfnChannelPolicy extends cdk.CfnResource implements cdk.IInspectable, IChannelPolicyRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnChannelPolicy from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnChannelPolicy; /** * Checks whether the given object is a CfnChannelPolicy */ static isCfnChannelPolicy(x: any): x is CfnChannelPolicy; /** * The name of the channel associated with this Channel Policy. */ private _channelName; /** * The IAM policy for the channel. */ private _policy; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::MediaTailor::ChannelPolicy`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnChannelPolicyProps); get channelPolicyRef(): ChannelPolicyReference; /** * The name of the channel associated with this Channel Policy. */ get channelName(): string; /** * The name of the channel associated with this Channel Policy. */ set channelName(value: string); /** * The IAM policy for the channel. */ get policy(): any | cdk.IResolvable; /** * The IAM policy for the channel. */ set policy(value: any | cdk.IResolvable); protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } /** * Properties for defining a `CfnChannelPolicy` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channelpolicy.html */ export interface CfnChannelPolicyProps { /** * The name of the channel associated with this Channel Policy. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channelpolicy.html#cfn-mediatailor-channelpolicy-channelname */ readonly channelName: string; /** * The IAM policy for the channel. * * IAM policies are used to control access to your channel. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-channelpolicy.html#cfn-mediatailor-channelpolicy-policy */ readonly policy: any | cdk.IResolvable; } /** * Live source configuration parameters. * * @cloudformationResource AWS::MediaTailor::LiveSource * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html */ export declare class CfnLiveSource extends cdk.CfnResource implements cdk.IInspectable, ILiveSourceRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnLiveSource from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnLiveSource; /** * Checks whether the given object is a CfnLiveSource */ static isCfnLiveSource(x: any): x is CfnLiveSource; static arnForLiveSource(resource: ILiveSourceRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The HTTP package configurations for the live source. */ private _httpPackageConfigurations; /** * The name that's used to refer to a live source. */ private _liveSourceName; /** * The name of the source location. */ private _sourceLocationName; /** * The tags assigned to the live source. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::MediaTailor::LiveSource`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnLiveSourceProps); get liveSourceRef(): LiveSourceReference; /** * The HTTP package configurations for the live source. */ get httpPackageConfigurations(): Array | cdk.IResolvable; /** * The HTTP package configurations for the live source. */ set httpPackageConfigurations(value: Array | cdk.IResolvable); /** * The name that's used to refer to a live source. */ get liveSourceName(): string; /** * The name that's used to refer to a live source. */ set liveSourceName(value: string); /** * The name of the source location. */ get sourceLocationName(): string; /** * The name of the source location. */ set sourceLocationName(value: string); /** * The tags assigned to the live source. */ get tags(): Array | undefined; /** * The tags assigned to the live source. */ set tags(value: Array | undefined); /** *

The ARN of the live source.

* * @cloudformationAttribute Arn */ get attrArn(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnLiveSource { /** * The HTTP package configuration properties for the requested VOD source. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html */ interface HttpPackageConfigurationProperty { /** * The relative path to the URL for this VOD source. * * This is combined with `SourceLocation::HttpConfiguration::BaseUrl` to form a valid URL. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html#cfn-mediatailor-livesource-httppackageconfiguration-path */ readonly path: string; /** * The name of the source group. * * This has to match one of the `Channel::Outputs::SourceGroup` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html#cfn-mediatailor-livesource-httppackageconfiguration-sourcegroup */ readonly sourceGroup: string; /** * The streaming protocol for this package configuration. * * Supported values are `HLS` and `DASH` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-livesource-httppackageconfiguration.html#cfn-mediatailor-livesource-httppackageconfiguration-type */ readonly type: string; } } /** * Properties for defining a `CfnLiveSource` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html */ export interface CfnLiveSourceProps { /** * The HTTP package configurations for the live source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-httppackageconfigurations */ readonly httpPackageConfigurations: Array | cdk.IResolvable; /** * The name that's used to refer to a live source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-livesourcename */ readonly liveSourceName: string; /** * The name of the source location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-sourcelocationname */ readonly sourceLocationName: string; /** * The tags assigned to the live source. * * Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-livesource.html#cfn-mediatailor-livesource-tags */ readonly tags?: Array; } /** * Adds a new playback configuration to AWS Elemental MediaTailor . * * @cloudformationResource AWS::MediaTailor::PlaybackConfiguration * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html */ export declare class CfnPlaybackConfiguration extends cdk.CfnResource implements cdk.IInspectable, IPlaybackConfigurationRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnPlaybackConfiguration from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPlaybackConfiguration; /** * Checks whether the given object is a CfnPlaybackConfiguration */ static isCfnPlaybackConfiguration(x: any): x is CfnPlaybackConfiguration; static arnForPlaybackConfiguration(resource: IPlaybackConfigurationRef): string; /** * The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads. */ private _adConditioningConfiguration?; /** * The configuration for the request to the specified Ad Decision Server URL. */ private _adDecisionServerConfiguration?; /** * The URL for the ad decision server (ADS). */ private _adDecisionServerUrl; /** * The settings that control how many concurrent requests MediaTailor makes to the ad decision server (ADS). */ private _adsPersonalizationConcurrency?; /** * The ad decision server (ADS) request timeouts and personalization time budgets for live, VOD, and prefetch workflows. */ private _adsPersonalizationTimeouts?; /** * The configuration for avail suppression, also known as ad suppression. */ private _availSuppression?; /** * The beaconing configuration for a playback configuration. */ private _beaconingConfiguration?; /** * The configuration for bumpers. */ private _bumper?; /** * The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. */ private _cdnConfiguration?; /** * The player parameters and aliases used as dynamic variables during session initialization. */ private _configurationAliases?; /** * The configuration for a DASH source. */ private _dashConfiguration?; /** * A map of event names to function identifiers for custom processing during session lifecycle events. */ private _functionMapping?; /** * The configuration for HLS content. */ private _hlsConfiguration?; /** * The setting that controls whether players can use stitched or guided ad insertion. */ private _insertionMode?; /** * The configuration for pre-roll ad insertion. */ private _livePreRollConfiguration?; /** * Defines where AWS Elemental MediaTailor sends logs for the playback configuration. */ private _logConfiguration?; /** * The configuration for manifest processing rules. */ private _manifestProcessingRules?; /** * The identifier for the playback configuration. */ private _name; /** * Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. */ private _personalizationThresholdSeconds?; /** * The URL for a video asset to transcode and use to fill in time that's not used by ads. */ private _slateAdUrl?; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * The tags to assign to the playback configuration. */ private _tagsRaw?; /** * The name that is used to associate this playback configuration with a custom transcode profile. */ private _transcodeProfileName?; /** * The URL prefix for the parent manifest for the stream, minus the asset ID. */ private _videoContentSourceUrl; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::MediaTailor::PlaybackConfiguration`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnPlaybackConfigurationProps); get playbackConfigurationRef(): PlaybackConfigurationReference; /** * The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads. */ get adConditioningConfiguration(): CfnPlaybackConfiguration.AdConditioningConfigurationProperty | cdk.IResolvable | undefined; /** * The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads. */ set adConditioningConfiguration(value: CfnPlaybackConfiguration.AdConditioningConfigurationProperty | cdk.IResolvable | undefined); /** * The configuration for the request to the specified Ad Decision Server URL. */ get adDecisionServerConfiguration(): CfnPlaybackConfiguration.AdDecisionServerConfigurationProperty | cdk.IResolvable | undefined; /** * The configuration for the request to the specified Ad Decision Server URL. */ set adDecisionServerConfiguration(value: CfnPlaybackConfiguration.AdDecisionServerConfigurationProperty | cdk.IResolvable | undefined); /** * The URL for the ad decision server (ADS). */ get adDecisionServerUrl(): string; /** * The URL for the ad decision server (ADS). */ set adDecisionServerUrl(value: string); /** * The settings that control how many concurrent requests MediaTailor makes to the ad decision server (ADS). */ get adsPersonalizationConcurrency(): CfnPlaybackConfiguration.AdsPersonalizationConcurrencyProperty | cdk.IResolvable | undefined; /** * The settings that control how many concurrent requests MediaTailor makes to the ad decision server (ADS). */ set adsPersonalizationConcurrency(value: CfnPlaybackConfiguration.AdsPersonalizationConcurrencyProperty | cdk.IResolvable | undefined); /** * The ad decision server (ADS) request timeouts and personalization time budgets for live, VOD, and prefetch workflows. */ get adsPersonalizationTimeouts(): CfnPlaybackConfiguration.AdsPersonalizationTimeoutsProperty | cdk.IResolvable | undefined; /** * The ad decision server (ADS) request timeouts and personalization time budgets for live, VOD, and prefetch workflows. */ set adsPersonalizationTimeouts(value: CfnPlaybackConfiguration.AdsPersonalizationTimeoutsProperty | cdk.IResolvable | undefined); /** * The configuration for avail suppression, also known as ad suppression. */ get availSuppression(): CfnPlaybackConfiguration.AvailSuppressionProperty | cdk.IResolvable | undefined; /** * The configuration for avail suppression, also known as ad suppression. */ set availSuppression(value: CfnPlaybackConfiguration.AvailSuppressionProperty | cdk.IResolvable | undefined); /** * The beaconing configuration for a playback configuration. */ get beaconingConfiguration(): CfnPlaybackConfiguration.BeaconingConfigurationProperty | cdk.IResolvable | undefined; /** * The beaconing configuration for a playback configuration. */ set beaconingConfiguration(value: CfnPlaybackConfiguration.BeaconingConfigurationProperty | cdk.IResolvable | undefined); /** * The configuration for bumpers. */ get bumper(): CfnPlaybackConfiguration.BumperProperty | cdk.IResolvable | undefined; /** * The configuration for bumpers. */ set bumper(value: CfnPlaybackConfiguration.BumperProperty | cdk.IResolvable | undefined); /** * The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. */ get cdnConfiguration(): CfnPlaybackConfiguration.CdnConfigurationProperty | cdk.IResolvable | undefined; /** * The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. */ set cdnConfiguration(value: CfnPlaybackConfiguration.CdnConfigurationProperty | cdk.IResolvable | undefined); /** * The player parameters and aliases used as dynamic variables during session initialization. */ get configurationAliases(): cdk.IResolvable | Record | undefined; /** * The player parameters and aliases used as dynamic variables during session initialization. */ set configurationAliases(value: cdk.IResolvable | Record | undefined); /** * The configuration for a DASH source. */ get dashConfiguration(): CfnPlaybackConfiguration.DashConfigurationProperty | cdk.IResolvable | undefined; /** * The configuration for a DASH source. */ set dashConfiguration(value: CfnPlaybackConfiguration.DashConfigurationProperty | cdk.IResolvable | undefined); /** * A map of event names to function identifiers for custom processing during session lifecycle events. */ get functionMapping(): cdk.IResolvable | Record | undefined; /** * A map of event names to function identifiers for custom processing during session lifecycle events. */ set functionMapping(value: cdk.IResolvable | Record | undefined); /** * The configuration for HLS content. */ get hlsConfiguration(): CfnPlaybackConfiguration.HlsConfigurationProperty | cdk.IResolvable | undefined; /** * The configuration for HLS content. */ set hlsConfiguration(value: CfnPlaybackConfiguration.HlsConfigurationProperty | cdk.IResolvable | undefined); /** * The setting that controls whether players can use stitched or guided ad insertion. */ get insertionMode(): string | undefined; /** * The setting that controls whether players can use stitched or guided ad insertion. */ set insertionMode(value: string | undefined); /** * The configuration for pre-roll ad insertion. */ get livePreRollConfiguration(): cdk.IResolvable | CfnPlaybackConfiguration.LivePreRollConfigurationProperty | undefined; /** * The configuration for pre-roll ad insertion. */ set livePreRollConfiguration(value: cdk.IResolvable | CfnPlaybackConfiguration.LivePreRollConfigurationProperty | undefined); /** * Defines where AWS Elemental MediaTailor sends logs for the playback configuration. */ get logConfiguration(): cdk.IResolvable | CfnPlaybackConfiguration.LogConfigurationProperty | undefined; /** * Defines where AWS Elemental MediaTailor sends logs for the playback configuration. */ set logConfiguration(value: cdk.IResolvable | CfnPlaybackConfiguration.LogConfigurationProperty | undefined); /** * The configuration for manifest processing rules. */ get manifestProcessingRules(): cdk.IResolvable | CfnPlaybackConfiguration.ManifestProcessingRulesProperty | undefined; /** * The configuration for manifest processing rules. */ set manifestProcessingRules(value: cdk.IResolvable | CfnPlaybackConfiguration.ManifestProcessingRulesProperty | undefined); /** * The identifier for the playback configuration. */ get name(): string; /** * The identifier for the playback configuration. */ set name(value: string); /** * Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. */ get personalizationThresholdSeconds(): number | undefined; /** * Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. */ set personalizationThresholdSeconds(value: number | undefined); /** * The URL for a video asset to transcode and use to fill in time that's not used by ads. */ get slateAdUrl(): string | undefined; /** * The URL for a video asset to transcode and use to fill in time that's not used by ads. */ set slateAdUrl(value: string | undefined); /** * The tags to assign to the playback configuration. */ get tagsRaw(): Array | undefined; /** * The tags to assign to the playback configuration. */ set tagsRaw(value: Array | undefined); /** * The name that is used to associate this playback configuration with a custom transcode profile. */ get transcodeProfileName(): string | undefined; /** * The name that is used to associate this playback configuration with a custom transcode profile. */ set transcodeProfileName(value: string | undefined); /** * The URL prefix for the parent manifest for the stream, minus the asset ID. */ get videoContentSourceUrl(): string; /** * The URL prefix for the parent manifest for the stream, minus the asset ID. */ set videoContentSourceUrl(value: string); /** * The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations. * * @cloudformationAttribute DashConfiguration.ManifestEndpointPrefix */ get attrDashConfigurationManifestEndpointPrefix(): string; /** * The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting. * * @cloudformationAttribute HlsConfiguration.ManifestEndpointPrefix */ get attrHlsConfigurationManifestEndpointPrefix(): string; /** * The Amazon Resource Name (ARN) for the playback configuration. * * @cloudformationAttribute PlaybackConfigurationArn */ get attrPlaybackConfigurationArn(): string; /** * The URL that the player accesses to get a manifest from MediaTailor . This session will use server-side reporting. * * @cloudformationAttribute PlaybackEndpointPrefix */ get attrPlaybackEndpointPrefix(): string; /** * The URL that the player uses to initialize a session that uses client-side reporting. * * @cloudformationAttribute SessionInitializationEndpointPrefix */ get attrSessionInitializationEndpointPrefix(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnPlaybackConfiguration { /** * 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](https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html */ interface BumperProperty { /** * The URL for the end bumper asset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html#cfn-mediatailor-playbackconfiguration-bumper-endurl */ readonly endUrl?: string; /** * The URL for the start bumper asset. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html#cfn-mediatailor-playbackconfiguration-bumper-starturl */ readonly startUrl?: string; } /** * The configuration for DASH content. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html */ interface DashConfigurationProperty { /** * The URL generated by MediaTailor to initiate a playback session. * * The session uses server-side reporting. This setting is ignored in PUT operations. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration-manifestendpointprefix */ readonly manifestEndpointPrefix?: string; /** * The setting that controls whether MediaTailor includes the Location tag in DASH manifests. * * MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are `DISABLED` and `EMT_DEFAULT` . The `EMT_DEFAULT` setting enables the inclusion of the tag and is the default value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration-mpdlocation */ readonly mpdLocation?: string; /** * The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. * * If your origin server produces single-period manifests, set this to `SINGLE_PERIOD` . The default setting is `MULTI_PERIOD` . For multi-period manifests, omit this setting or set it to `MULTI_PERIOD` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration-originmanifesttype */ readonly originManifestType?: string; } /** * The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html */ interface CdnConfigurationProperty { /** * A non-default content delivery network (CDN) to serve ad segments. * * By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor. ** .amazonaws.com. Then specify the rule's name in this `AdSegmentUrlPrefix` . When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration-adsegmenturlprefix */ readonly adSegmentUrlPrefix?: string; /** * A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. * * First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this `ContentSegmentUrlPrefix` . When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration-contentsegmenturlprefix */ readonly contentSegmentUrlPrefix?: string; } /** * The configuration for manifest processing rules. * * Manifest processing rules enable customization of the personalized manifests created by MediaTailor. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestprocessingrules.html */ interface ManifestProcessingRulesProperty { /** * For HLS, when set to `true` , MediaTailor passes through `EXT-X-CUE-IN` , `EXT-X-CUE-OUT` , and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest. * * No logic is applied to these ad markers. For example, if `EXT-X-CUE-OUT` has a value of `60` , but no ads are filled for that ad break, MediaTailor will not set the value to `0` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestprocessingrules.html#cfn-mediatailor-playbackconfiguration-manifestprocessingrules-admarkerpassthrough */ readonly adMarkerPassthrough?: CfnPlaybackConfiguration.AdMarkerPassthroughProperty | cdk.IResolvable; } /** * For HLS, when set to `true` , MediaTailor passes through `EXT-X-CUE-IN` , `EXT-X-CUE-OUT` , and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest. * * No logic is applied to these ad markers. For example, if `EXT-X-CUE-OUT` has a value of `60` , but no ads are filled for that ad break, MediaTailor will not set the value to `0` . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.html */ interface AdMarkerPassthroughProperty { /** * Enables ad marker passthrough for your configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.html#cfn-mediatailor-playbackconfiguration-admarkerpassthrough-enabled */ readonly enabled?: boolean | cdk.IResolvable; } /** * The configuration for pre-roll ad insertion. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html */ interface LivePreRollConfigurationProperty { /** * The configuration for the request to the pre-roll Ad Decision Server. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration-addecisionserverconfiguration */ readonly adDecisionServerConfiguration?: cdk.IResolvable | CfnPlaybackConfiguration.PreRollAdDecisionServerConfigurationProperty; /** * The URL for the ad decision server (ADS) for pre-roll 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration-addecisionserverurl */ readonly adDecisionServerUrl?: string; /** * The maximum allowed duration for the pre-roll ad avail. * * AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration-maxdurationseconds */ readonly maxDurationSeconds?: number; } /** * The configuration for the request to the pre-roll Ad Decision Server. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-prerolladdecisionserverconfiguration.html */ interface PreRollAdDecisionServerConfigurationProperty { /** * The configuration for how MediaTailor processes the VAST response returned by the pre-roll Ad Decision Server. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-prerolladdecisionserverconfiguration.html#cfn-mediatailor-playbackconfiguration-prerolladdecisionserverconfiguration-vastresponse */ readonly vastResponse?: cdk.IResolvable | CfnPlaybackConfiguration.PreRollVastResponseProperty; } /** * The configuration for how MediaTailor processes the VAST response returned by the pre-roll Ad Decision Server. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-prerollvastresponse.html */ interface PreRollVastResponseProperty { /** * Determines how MediaTailor sequences ads returned in the pre-roll VAST response. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-prerollvastresponse.html#cfn-mediatailor-playbackconfiguration-prerollvastresponse-adsequencingmode */ readonly adSequencingMode?: string; } /** * The configuration for HLS content. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-hlsconfiguration.html */ interface HlsConfigurationProperty { /** * The URL that is used to initiate a playback session for devices that support Apple HLS. * * The session uses server-side reporting. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-hlsconfiguration.html#cfn-mediatailor-playbackconfiguration-hlsconfiguration-manifestendpointprefix */ readonly manifestEndpointPrefix?: string; } /** * The configuration for avail suppression, also known as ad suppression. * * For more information about ad suppression, see [Ad Suppression](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html */ interface AvailSuppressionProperty { /** * 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 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-fillpolicy */ readonly fillPolicy?: string; /** * 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 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-mode */ readonly mode?: string; /** * 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 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html#cfn-mediatailor-playbackconfiguration-availsuppression-value */ readonly value?: string; } /** * The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adconditioningconfiguration.html */ interface AdConditioningConfigurationProperty { /** * For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. * * `TRANSCODE` indicates that MediaTailor must transcode the ads. `NONE` indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see [Using preconditioned ads](https://docs.aws.amazon.com/mediatailor/latest/ug/precondition-ads.html) in the AWS Elemental MediaTailor user guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adconditioningconfiguration.html#cfn-mediatailor-playbackconfiguration-adconditioningconfiguration-streamingmediafileconditioning */ readonly streamingMediaFileConditioning: string; } /** * The beaconing configuration for a playback configuration. * * Beaconing controls whether AWS Elemental MediaTailor includes its own beacons in the ad tracking response, in addition to the ad server beacons. If you omit this setting, MediaTailor uses INSIGHTS. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-beaconingconfiguration.html */ interface BeaconingConfigurationProperty { /** * The beaconing settings that apply to client-side reporting sessions: whether AWS Elemental MediaTailor includes its beacons in the ad tracking response, and which player operation events it reports on. * * If you omit this object, MediaTailor uses INSIGHTS reporting mode. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-beaconingconfiguration.html#cfn-mediatailor-playbackconfiguration-beaconingconfiguration-clientside */ readonly clientSide?: CfnPlaybackConfiguration.ClientSideBeaconingConfigurationProperty | cdk.IResolvable; } /** * The beaconing settings that apply to client-side reporting sessions: whether AWS Elemental MediaTailor includes its beacons in the ad tracking response, and which player operation events it reports on. * * If you omit this object, MediaTailor uses INSIGHTS reporting mode. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-clientsidebeaconingconfiguration.html */ interface ClientSideBeaconingConfigurationProperty { /** * The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. * * Valid values are MUTE, UNMUTE, PAUSE, and SKIP. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-clientsidebeaconingconfiguration.html#cfn-mediatailor-playbackconfiguration-clientsidebeaconingconfiguration-additionaleventtypes */ readonly additionalEventTypes?: Array; /** * Specifies whether MediaTailor includes its beacons in the ad tracking response. * * INSIGHTS includes MediaTailor beacons; DISABLED does not. Values are case-sensitive. This setting is required when ClientSide is present. If BeaconingConfiguration or ClientSide is omitted, MediaTailor uses INSIGHTS. To keep beaconing off, retain DISABLED in subsequent updates. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-clientsidebeaconingconfiguration.html#cfn-mediatailor-playbackconfiguration-clientsidebeaconingconfiguration-reportingmode */ readonly reportingMode: string; } /** * Defines where AWS Elemental MediaTailor sends logs for the playback configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html */ interface LogConfigurationProperty { /** * Settings for customizing what events are included in logs for interactions with the ad decision server (ADS). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-adsinteractionlog */ readonly adsInteractionLog?: CfnPlaybackConfiguration.AdsInteractionLogProperty | cdk.IResolvable; /** * The method used for collecting logs from AWS Elemental MediaTailor. * * `LEGACY_CLOUDWATCH` indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. `VENDED_LOGS` indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-enabledloggingstrategies */ readonly enabledLoggingStrategies?: Array; /** * Settings for customizing what events are included in logs for interactions with the origin server. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-manifestserviceinteractionlog */ readonly manifestServiceInteractionLog?: cdk.IResolvable | CfnPlaybackConfiguration.ManifestServiceInteractionLogProperty; /** * The percentage of session logs that MediaTailor sends to your configured log destination. * * For example, if your playback configuration has 1000 sessions and `percentEnabled` is set to `60` , MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the [debug log mode](https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html) . * * Valid values: `0` - `100` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-logconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration-percentenabled */ readonly percentEnabled: number; } /** * Settings for customizing what events are included in logs for interactions with the ad decision server (ADS). * * For more information about ADS logs, inlcuding descriptions of the event types, see [MediaTailor ADS logs description and event types](https://docs.aws.amazon.com/mediatailor/latest/ug/ads-log-format.html) in AWS Elemental MediaTailor User Guide. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html */ interface AdsInteractionLogProperty { /** * Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html#cfn-mediatailor-playbackconfiguration-adsinteractionlog-excludeeventtypes */ readonly excludeEventTypes?: Array; /** * Indicates that MediaTailor emits `RAW_ADS_RESPONSE` logs for playback sessions that are initialized with this configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adsinteractionlog.html#cfn-mediatailor-playbackconfiguration-adsinteractionlog-publishoptineventtypes */ readonly publishOptInEventTypes?: Array; } /** * Settings for customizing what events are included in logs for interactions with the origin server. * * For more information about manifest service logs, including descriptions of the event types, see [MediaTailor manifest logs description and event types](https://docs.aws.amazon.com/mediatailor/latest/ug/log-types.html) in AWS Elemental MediaTailor User Guide. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestserviceinteractionlog.html */ interface ManifestServiceInteractionLogProperty { /** * Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestserviceinteractionlog.html#cfn-mediatailor-playbackconfiguration-manifestserviceinteractionlog-excludeeventtypes */ readonly excludeEventTypes?: Array; } /** * The configuration for the request to the specified Ad Decision Server URL. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-addecisionserverconfiguration.html */ interface AdDecisionServerConfigurationProperty { /** * The configuration for the request to the Ad Decision Server URL. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-addecisionserverconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverconfiguration-httprequest */ readonly httpRequest?: CfnPlaybackConfiguration.HttpRequestProperty | cdk.IResolvable; /** * The configuration for how MediaTailor processes the VAST response returned by the Ad Decision Server. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-addecisionserverconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverconfiguration-vastresponse */ readonly vastResponse?: cdk.IResolvable | CfnPlaybackConfiguration.VastResponseProperty; } /** * The configuration for the request to the Ad Decision Server URL. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html */ interface HttpRequestProperty { /** * The body of the request to the Ad Decision Server URL. * * The maximum length is 100,000 characters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-body */ readonly body?: string; /** * The compression type of the request sent to the Ad Decision Server URL. * * Only the POST HTTP Method permits compression other than NONE. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-compressrequest */ readonly compressRequest?: string; /** * The headers in the request sent to the Ad Decision Server URL. * * The max length is 10,000 characters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-headers */ readonly headers?: cdk.IResolvable | Record; /** * Supported HTTP Methods for the request to the Ad Decision Server URL. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-httprequest.html#cfn-mediatailor-playbackconfiguration-httprequest-httpmethod */ readonly httpMethod?: string; } /** * The configuration for how MediaTailor processes the VAST response returned by the Ad Decision Server. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-vastresponse.html */ interface VastResponseProperty { /** * Determines how MediaTailor sequences ads returned in the VAST response from the Ad Decision Server. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-vastresponse.html#cfn-mediatailor-playbackconfiguration-vastresponse-adsequencingmode */ readonly adSequencingMode?: string; } /** * The ad decision server (ADS) request timeouts and personalization time budgets for live, VOD, and prefetch workflows. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adspersonalizationtimeouts.html */ interface AdsPersonalizationTimeoutsProperty { /** * The maximum time, in milliseconds, that MediaTailor waits for a single ADS response during live or VOD playback. * * The default is 3000. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adspersonalizationtimeouts.html#cfn-mediatailor-playbackconfiguration-adspersonalizationtimeouts-adsrequesttimeoutmilliseconds */ readonly adsRequestTimeoutMilliseconds?: number; /** * The maximum total time, in milliseconds, that MediaTailor spends on ADS activity for live manifests. * * The default is 10000. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adspersonalizationtimeouts.html#cfn-mediatailor-playbackconfiguration-adspersonalizationtimeouts-livemaximumadspersonalizationtimemilliseconds */ readonly liveMaximumAdsPersonalizationTimeMilliseconds?: number; /** * The maximum time, in milliseconds, that MediaTailor waits for a single ADS response during prefetch retrieval. * * If not set, MediaTailor uses the AdsRequestTimeoutMilliseconds value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adspersonalizationtimeouts.html#cfn-mediatailor-playbackconfiguration-adspersonalizationtimeouts-prefetchadsrequesttimeoutmilliseconds */ readonly prefetchAdsRequestTimeoutMilliseconds?: number; /** * The maximum total time, in milliseconds, that MediaTailor spends on ADS activity during prefetch retrieval. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adspersonalizationtimeouts.html#cfn-mediatailor-playbackconfiguration-adspersonalizationtimeouts-prefetchmaximumadspersonalizationtimemilliseconds */ readonly prefetchMaximumAdsPersonalizationTimeMilliseconds?: number; /** * The maximum total time, in milliseconds, that MediaTailor spends on ADS activity for VOD manifests. * * The default is 10000. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adspersonalizationtimeouts.html#cfn-mediatailor-playbackconfiguration-adspersonalizationtimeouts-vodmaximumadspersonalizationtimemilliseconds */ readonly vodMaximumAdsPersonalizationTimeMilliseconds?: number; } /** * The settings that control how many concurrent requests MediaTailor makes to the ad decision server (ADS). * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adspersonalizationconcurrency.html */ interface AdsPersonalizationConcurrencyProperty { /** * Enables parallel processing of ADS requests in VOD workflows when the ADS returns VAST responses. * * The default is false. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adspersonalizationconcurrency.html#cfn-mediatailor-playbackconfiguration-adspersonalizationconcurrency-enablevodvastparallelization */ readonly enableVodVastParallelization?: boolean | cdk.IResolvable; /** * The maximum number of simultaneous requests that MediaTailor makes to the ADS for each manifest request. * * The default is 1. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-adspersonalizationconcurrency.html#cfn-mediatailor-playbackconfiguration-adspersonalizationconcurrency-maxconcurrentadsrequests */ readonly maxConcurrentAdsRequests?: number; } } /** * Properties for defining a `CfnPlaybackConfiguration` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html */ export interface CfnPlaybackConfigurationProps { /** * The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-adconditioningconfiguration */ readonly adConditioningConfiguration?: CfnPlaybackConfiguration.AdConditioningConfigurationProperty | cdk.IResolvable; /** * The configuration for the request to the specified Ad Decision Server URL. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverconfiguration */ readonly adDecisionServerConfiguration?: CfnPlaybackConfiguration.AdDecisionServerConfigurationProperty | cdk.IResolvable; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-addecisionserverurl */ readonly adDecisionServerUrl: string; /** * The settings that control how many concurrent requests MediaTailor makes to the ad decision server (ADS). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-adspersonalizationconcurrency */ readonly adsPersonalizationConcurrency?: CfnPlaybackConfiguration.AdsPersonalizationConcurrencyProperty | cdk.IResolvable; /** * The ad decision server (ADS) request timeouts and personalization time budgets for live, VOD, and prefetch workflows. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-adspersonalizationtimeouts */ readonly adsPersonalizationTimeouts?: CfnPlaybackConfiguration.AdsPersonalizationTimeoutsProperty | cdk.IResolvable; /** * The configuration for avail suppression, also known as ad suppression. * * For more information about ad suppression, see [Ad Suppression](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-availsuppression */ readonly availSuppression?: CfnPlaybackConfiguration.AvailSuppressionProperty | cdk.IResolvable; /** * The beaconing configuration for a playback configuration. * * Beaconing controls whether AWS Elemental MediaTailor includes its own beacons in the ad tracking response, in addition to the ad server beacons. If you omit this setting, MediaTailor uses INSIGHTS. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-beaconingconfiguration */ readonly beaconingConfiguration?: CfnPlaybackConfiguration.BeaconingConfigurationProperty | cdk.IResolvable; /** * 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](https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-bumper */ readonly bumper?: CfnPlaybackConfiguration.BumperProperty | cdk.IResolvable; /** * The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-cdnconfiguration */ readonly cdnConfiguration?: CfnPlaybackConfiguration.CdnConfigurationProperty | cdk.IResolvable; /** * The player parameters and aliases used as dynamic variables during session initialization. * * For more information, see [Domain Variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-configurationaliases */ readonly configurationAliases?: cdk.IResolvable | Record; /** * The configuration for a DASH source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-dashconfiguration */ readonly dashConfiguration?: CfnPlaybackConfiguration.DashConfigurationProperty | cdk.IResolvable; /** * A map of event names to function identifiers for custom processing during session lifecycle events. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-functionmapping */ readonly functionMapping?: cdk.IResolvable | Record; /** * The configuration for HLS content. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-hlsconfiguration */ readonly hlsConfiguration?: CfnPlaybackConfiguration.HlsConfigurationProperty | cdk.IResolvable; /** * The setting that controls whether players can use stitched or guided ad insertion. * * The default, `STITCHED_ONLY` , forces all player sessions to use stitched (server-side) ad insertion. Choosing `PLAYER_SELECT` allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-insertionmode */ readonly insertionMode?: string; /** * The configuration for pre-roll ad insertion. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-liveprerollconfiguration */ readonly livePreRollConfiguration?: cdk.IResolvable | CfnPlaybackConfiguration.LivePreRollConfigurationProperty; /** * Defines where AWS Elemental MediaTailor sends logs for the playback configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-logconfiguration */ readonly logConfiguration?: cdk.IResolvable | CfnPlaybackConfiguration.LogConfigurationProperty; /** * The configuration for manifest processing rules. * * Manifest processing rules enable customization of the personalized manifests created by MediaTailor. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-manifestprocessingrules */ readonly manifestProcessingRules?: cdk.IResolvable | CfnPlaybackConfiguration.ManifestProcessingRulesProperty; /** * The identifier for the playback configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-name */ readonly name: string; /** * 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](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-personalizationthresholdseconds */ readonly personalizationThresholdSeconds?: number; /** * The URL for a 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 playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-slateadurl */ readonly slateAdUrl?: string; /** * The tags to assign to the playback configuration. * * Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-tags */ readonly tags?: Array; /** * 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. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-transcodeprofilename */ readonly transcodeProfileName?: string; /** * The URL prefix for the parent manifest for the stream, minus the asset ID. * * The maximum length is 512 characters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html#cfn-mediatailor-playbackconfiguration-videocontentsourceurl */ readonly videoContentSourceUrl: string; } /** * A source location is a container for sources. * * For more information about source locations, see [Working with source locations](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) in the *MediaTailor User Guide* . * * @cloudformationResource AWS::MediaTailor::SourceLocation * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html */ export declare class CfnSourceLocation extends cdk.CfnResource implements cdk.IInspectable, ISourceLocationRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnSourceLocation from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSourceLocation; /** * Checks whether the given object is a CfnSourceLocation */ static isCfnSourceLocation(x: any): x is CfnSourceLocation; static arnForSourceLocation(resource: ISourceLocationRef): string; /** * The access configuration for the source location. */ private _accessConfiguration?; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The default segment delivery configuration. */ private _defaultSegmentDeliveryConfiguration?; /** * The HTTP configuration for the source location. */ private _httpConfiguration; /** * The segment delivery configurations for the source location. */ private _segmentDeliveryConfigurations?; /** * The name of the source location. */ private _sourceLocationName; /** * The tags assigned to the source location. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::MediaTailor::SourceLocation`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnSourceLocationProps); get sourceLocationRef(): SourceLocationReference; /** * The access configuration for the source location. */ get accessConfiguration(): CfnSourceLocation.AccessConfigurationProperty | cdk.IResolvable | undefined; /** * The access configuration for the source location. */ set accessConfiguration(value: CfnSourceLocation.AccessConfigurationProperty | cdk.IResolvable | undefined); /** * The default segment delivery configuration. */ get defaultSegmentDeliveryConfiguration(): CfnSourceLocation.DefaultSegmentDeliveryConfigurationProperty | cdk.IResolvable | undefined; /** * The default segment delivery configuration. */ set defaultSegmentDeliveryConfiguration(value: CfnSourceLocation.DefaultSegmentDeliveryConfigurationProperty | cdk.IResolvable | undefined); /** * The HTTP configuration for the source location. */ get httpConfiguration(): CfnSourceLocation.HttpConfigurationProperty | cdk.IResolvable; /** * The HTTP configuration for the source location. */ set httpConfiguration(value: CfnSourceLocation.HttpConfigurationProperty | cdk.IResolvable); /** * The segment delivery configurations for the source location. */ get segmentDeliveryConfigurations(): Array | cdk.IResolvable | undefined; /** * The segment delivery configurations for the source location. */ set segmentDeliveryConfigurations(value: Array | cdk.IResolvable | undefined); /** * The name of the source location. */ get sourceLocationName(): string; /** * The name of the source location. */ set sourceLocationName(value: string); /** * The tags assigned to the source location. */ get tags(): Array | undefined; /** * The tags assigned to the source location. */ set tags(value: Array | undefined); /** *

The ARN of the source location.

* * @cloudformationAttribute Arn */ get attrArn(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnSourceLocation { /** * The optional configuration for a server that serves segments. * * Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration.html */ interface DefaultSegmentDeliveryConfigurationProperty { /** * The hostname of the server that will be used to serve segments. * * This string must include the protocol, such as *https://* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration-baseurl */ readonly baseUrl?: string; } /** * The segment delivery configuration settings. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html */ interface SegmentDeliveryConfigurationProperty { /** * The base URL of the host or path of the segment delivery server that you're using to serve segments. * * This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as `https://example.com/some/path` . To use a relative URL specify the relative path, such as `/some/path*` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfiguration-baseurl */ readonly baseUrl?: string; /** * A unique identifier used to distinguish between multiple segment delivery configurations in a source location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-segmentdeliveryconfiguration.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfiguration-name */ readonly name?: string; } /** * The HTTP configuration for the source location. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-httpconfiguration.html */ interface HttpConfigurationProperty { /** * The base URL for the source location host server. * * This string must include the protocol, such as *https://* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-httpconfiguration.html#cfn-mediatailor-sourcelocation-httpconfiguration-baseurl */ readonly baseUrl: string; } /** * Access configuration parameters. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html */ interface AccessConfigurationProperty { /** * The type of authentication used to access content from `HttpConfiguration::BaseUrl` on your source location. Accepted value: `S3_SIGV4` . * * `S3_SIGV4` - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name. * * Before you can use `S3_SIGV4` , you must meet these requirements: * * • You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide. * * • The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations. * * • The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html#cfn-mediatailor-sourcelocation-accessconfiguration-accesstype */ readonly accessType?: string; /** * AWS Secrets Manager access token configuration parameters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-accessconfiguration.html#cfn-mediatailor-sourcelocation-accessconfiguration-secretsmanageraccesstokenconfiguration */ readonly secretsManagerAccessTokenConfiguration?: cdk.IResolvable | CfnSourceLocation.SecretsManagerAccessTokenConfigurationProperty; } /** * AWS Secrets Manager access token configuration parameters. * * For information about Secrets Manager access token authentication, see [Working with AWS Secrets Manager access token authentication](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html) . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html */ interface SecretsManagerAccessTokenConfigurationProperty { /** * The name of the HTTP header used to supply the access token in requests to the source location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-headername */ readonly headerName?: string; /** * The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-secretarn */ readonly secretArn?: string; /** * The AWS Secrets Manager [SecretString](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html) key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration.html#cfn-mediatailor-sourcelocation-secretsmanageraccesstokenconfiguration-secretstringkey */ readonly secretStringKey?: string; } } /** * Properties for defining a `CfnSourceLocation` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html */ export interface CfnSourceLocationProps { /** * The access configuration for the source location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-accessconfiguration */ readonly accessConfiguration?: CfnSourceLocation.AccessConfigurationProperty | cdk.IResolvable; /** * The default segment delivery configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-defaultsegmentdeliveryconfiguration */ readonly defaultSegmentDeliveryConfiguration?: CfnSourceLocation.DefaultSegmentDeliveryConfigurationProperty | cdk.IResolvable; /** * The HTTP configuration for the source location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-httpconfiguration */ readonly httpConfiguration: CfnSourceLocation.HttpConfigurationProperty | cdk.IResolvable; /** * The segment delivery configurations for the source location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-segmentdeliveryconfigurations */ readonly segmentDeliveryConfigurations?: Array | cdk.IResolvable; /** * The name of the source location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-sourcelocationname */ readonly sourceLocationName: string; /** * The tags assigned to the source location. * * Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-sourcelocation.html#cfn-mediatailor-sourcelocation-tags */ readonly tags?: Array; } /** * The VOD source configuration parameters. * * @cloudformationResource AWS::MediaTailor::VodSource * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html */ export declare class CfnVodSource extends cdk.CfnResource implements cdk.IInspectable, IVodSourceRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnVodSource from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnVodSource; /** * Checks whether the given object is a CfnVodSource */ static isCfnVodSource(x: any): x is CfnVodSource; static arnForVodSource(resource: IVodSourceRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The HTTP package configurations for the VOD source. */ private _httpPackageConfigurations; /** * The name of the source location that the VOD source is associated with. */ private _sourceLocationName; /** * The tags assigned to the VOD source. */ private _tags?; /** * The name of the VOD source. */ private _vodSourceName; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::MediaTailor::VodSource`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnVodSourceProps); get vodSourceRef(): VodSourceReference; /** * The HTTP package configurations for the VOD source. */ get httpPackageConfigurations(): Array | cdk.IResolvable; /** * The HTTP package configurations for the VOD source. */ set httpPackageConfigurations(value: Array | cdk.IResolvable); /** * The name of the source location that the VOD source is associated with. */ get sourceLocationName(): string; /** * The name of the source location that the VOD source is associated with. */ set sourceLocationName(value: string); /** * The tags assigned to the VOD source. */ get tags(): Array | undefined; /** * The tags assigned to the VOD source. */ set tags(value: Array | undefined); /** * The name of the VOD source. */ get vodSourceName(): string; /** * The name of the VOD source. */ set vodSourceName(value: string); /** *

The ARN of the VOD source.

* * @cloudformationAttribute Arn */ get attrArn(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnVodSource { /** * The HTTP package configuration properties for the requested VOD source. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html */ interface HttpPackageConfigurationProperty { /** * The relative path to the URL for this VOD source. * * This is combined with `SourceLocation::HttpConfiguration::BaseUrl` to form a valid URL. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html#cfn-mediatailor-vodsource-httppackageconfiguration-path */ readonly path: string; /** * The name of the source group. * * This has to match one of the `Channel::Outputs::SourceGroup` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html#cfn-mediatailor-vodsource-httppackageconfiguration-sourcegroup */ readonly sourceGroup: string; /** * The streaming protocol for this package configuration. * * Supported values are `HLS` and `DASH` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-vodsource-httppackageconfiguration.html#cfn-mediatailor-vodsource-httppackageconfiguration-type */ readonly type: string; } } /** * Properties for defining a `CfnVodSource` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html */ export interface CfnVodSourceProps { /** * The HTTP package configurations for the VOD source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-httppackageconfigurations */ readonly httpPackageConfigurations: Array | cdk.IResolvable; /** * The name of the source location that the VOD source is associated with. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-sourcelocationname */ readonly sourceLocationName: string; /** * The tags assigned to the VOD source. * * Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-tags */ readonly tags?: Array; /** * The name of the VOD source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-vodsource.html#cfn-mediatailor-vodsource-vodsourcename */ readonly vodSourceName: string; } /** * Resource Type definition for AWS::MediaTailor::Function. * * @cloudformationResource AWS::MediaTailor::Function * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html */ export declare class CfnFunction extends cdk.CfnResource implements cdk.IInspectable, IFunctionRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnFunction from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnFunction; /** * Checks whether the given object is a CfnFunction */ static isCfnFunction(x: any): x is CfnFunction; static arnForFunction(resource: IFunctionRef): string; /** * The configuration for an AWS_SERVICE_REQUEST function. */ private _awsServiceRequestConfiguration?; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * The configuration for a CONCURRENT_EXECUTOR function. */ private _concurrentExecutorConfiguration?; /** * Configuration for custom output functions. */ private _customOutputConfiguration?; /** * A description of the function. */ private _description?; /** * The unique identifier for the function. */ private _functionId; private _functionType; /** * Configuration for HTTP request functions. */ private _httpRequestConfiguration?; /** * The configuration for a SEQUENTIAL_EXECUTOR function. */ private _sequentialExecutorConfiguration?; /** * The tags to assign to the function resource. */ private _tags?; /** * The configuration for a VAST_REQUEST function. */ private _vastRequestConfiguration?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::MediaTailor::Function`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnFunctionProps); get functionRef(): FunctionReference; /** * The configuration for an AWS_SERVICE_REQUEST function. */ get awsServiceRequestConfiguration(): CfnFunction.AwsServiceRequestConfigurationProperty | cdk.IResolvable | undefined; /** * The configuration for an AWS_SERVICE_REQUEST function. */ set awsServiceRequestConfiguration(value: CfnFunction.AwsServiceRequestConfigurationProperty | cdk.IResolvable | undefined); /** * The configuration for a CONCURRENT_EXECUTOR function. */ get concurrentExecutorConfiguration(): CfnFunction.ConcurrentExecutorConfigurationProperty | cdk.IResolvable | undefined; /** * The configuration for a CONCURRENT_EXECUTOR function. */ set concurrentExecutorConfiguration(value: CfnFunction.ConcurrentExecutorConfigurationProperty | cdk.IResolvable | undefined); /** * Configuration for custom output functions. */ get customOutputConfiguration(): CfnFunction.CustomOutputConfigurationProperty | cdk.IResolvable | undefined; /** * Configuration for custom output functions. */ set customOutputConfiguration(value: CfnFunction.CustomOutputConfigurationProperty | cdk.IResolvable | undefined); /** * A description of the function. */ get description(): string | undefined; /** * A description of the function. */ set description(value: string | undefined); /** * The unique identifier for the function. */ get functionId(): string; /** * The unique identifier for the function. */ set functionId(value: string); get functionType(): string; set functionType(value: string); /** * Configuration for HTTP request functions. */ get httpRequestConfiguration(): CfnFunction.HttpRequestConfigurationProperty | cdk.IResolvable | undefined; /** * Configuration for HTTP request functions. */ set httpRequestConfiguration(value: CfnFunction.HttpRequestConfigurationProperty | cdk.IResolvable | undefined); /** * The configuration for a SEQUENTIAL_EXECUTOR function. */ get sequentialExecutorConfiguration(): cdk.IResolvable | CfnFunction.SequentialExecutorConfigurationProperty | undefined; /** * The configuration for a SEQUENTIAL_EXECUTOR function. */ set sequentialExecutorConfiguration(value: cdk.IResolvable | CfnFunction.SequentialExecutorConfigurationProperty | undefined); /** * The tags to assign to the function resource. */ get tags(): Array | undefined; /** * The tags to assign to the function resource. */ set tags(value: Array | undefined); /** * The configuration for a VAST_REQUEST function. */ get vastRequestConfiguration(): cdk.IResolvable | CfnFunction.VastRequestConfigurationProperty | undefined; /** * The configuration for a VAST_REQUEST function. */ set vastRequestConfiguration(value: cdk.IResolvable | CfnFunction.VastRequestConfigurationProperty | undefined); /** * The ARN of the function. * * @cloudformationAttribute Arn */ get attrArn(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnFunction { /** * Configuration for HTTP request functions. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html */ interface HttpRequestConfigurationProperty { /** * The body of the HTTP request. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-body */ readonly body?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-headers */ readonly headers?: cdk.IResolvable | Record; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-methodtype */ readonly methodType: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-output */ readonly output?: cdk.IResolvable | Record; /** * The timeout in milliseconds for the HTTP request. * * Maximum value is 2000. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-requesttimeoutmilliseconds */ readonly requestTimeoutMilliseconds: number; /** * The expression language used to evaluate expressions in the function configuration. * * Set this to JSONATA. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-runtime */ readonly runtime: string; /** * The URL endpoint for the HTTP request. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-httprequestconfiguration.html#cfn-mediatailor-function-httprequestconfiguration-url */ readonly url: string; } /** * The configuration for an AWS_SERVICE_REQUEST function. * * Contains the target service, target Region, and request parameters that the function uses to call an AWS service API. For more information, see AWS_SERVICE_REQUEST (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types-aws-service-request.html) in the MediaTailor User Guide. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html */ interface AwsServiceRequestConfigurationProperty { /** * An expression that evaluates to the request body for the AWS service API call. * * The body must conform to the input format that the target service operation expects. Applies only when the target operation accepts a request body. The maximum size after evaluation is 64 KB. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html#cfn-mediatailor-function-awsservicerequestconfiguration-body */ readonly body?: string; /** * A map of HTTP header names to expression values. * * MediaTailor evaluates each header value expression at runtime and includes the result in the outbound request to the AWS service. Use this to pass any headers required by the target service operation. You can include a maximum of 50 headers. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html#cfn-mediatailor-function-awsservicerequestconfiguration-headers */ readonly headers?: cdk.IResolvable | Record; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html#cfn-mediatailor-function-awsservicerequestconfiguration-methodtype */ readonly methodType: string; /** * A map of output bindings. * * Each key is a namespaced output path, such as player_params.device_type. Each value is an expression that MediaTailor evaluates at runtime and can reference the response object from the target service. For more information, see JSONata expression reference (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-jsonata.html) in the MediaTailor User Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html#cfn-mediatailor-function-awsservicerequestconfiguration-output */ readonly output?: cdk.IResolvable | Record; /** * The maximum time, in milliseconds, that MediaTailor waits for a response from the AWS service. * * If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values are 100 to 2000. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html#cfn-mediatailor-function-awsservicerequestconfiguration-requesttimeoutmilliseconds */ readonly requestTimeoutMilliseconds: number; /** * The expression language used to evaluate expressions in the function configuration. * * Set this to JSONATA. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html#cfn-mediatailor-function-awsservicerequestconfiguration-runtime */ readonly runtime: string; /** * The AWS Region for the target service. * * Specify a static Region code (for example, us-east-1) or a JSONata expression that resolves to a Region code at runtime (for example, {%inference.region%}). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html#cfn-mediatailor-function-awsservicerequestconfiguration-targetregion */ readonly targetRegion: string; /** * The AWS service to call. * * Valid value: elemental-inference (AWS Elemental Inference). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html#cfn-mediatailor-function-awsservicerequestconfiguration-targetservice */ readonly targetService: string; /** * An expression that evaluates to the endpoint URL for the target AWS service API operation. * * Use {%...%} delimiters for dynamic expressions. The URL must correspond to a valid endpoint for the service specified in TargetService. The maximum length after evaluation is 2,048 characters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-awsservicerequestconfiguration.html#cfn-mediatailor-function-awsservicerequestconfiguration-url */ readonly url: string; } /** * Configuration for custom output functions. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-customoutputconfiguration.html */ interface CustomOutputConfigurationProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-customoutputconfiguration.html#cfn-mediatailor-function-customoutputconfiguration-output */ readonly output?: cdk.IResolvable | Record; /** * The expression language used to evaluate expressions in the function configuration. * * Set this to JSONATA. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-customoutputconfiguration.html#cfn-mediatailor-function-customoutputconfiguration-runtime */ readonly runtime: string; } /** * The configuration for a CONCURRENT_EXECUTOR function. * * A CONCURRENT_EXECUTOR runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete. For more information about functions, see Working with functions (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions.html) in the MediaTailor User Guide. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-concurrentexecutorconfiguration.html */ interface ConcurrentExecutorConfigurationProperty { /** * The list of 1 to 10 child functions that MediaTailor runs in parallel. * * Each entry specifies a child function to execute and an optional run condition expression that controls whether the function runs. Child functions cannot themselves be executors, and each child function's resolved namespace must be unique across the list. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-concurrentexecutorconfiguration.html#cfn-mediatailor-function-concurrentexecutorconfiguration-functionlist */ readonly functionList: Array | cdk.IResolvable; /** * The maximum number of child functions that MediaTailor runs simultaneously. * * When the list contains more functions than MaxConcurrency, MediaTailor starts additional functions as running ones complete, so that no more than MaxConcurrency functions run at the same time. Valid values are 1 to 2. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-concurrentexecutorconfiguration.html#cfn-mediatailor-function-concurrentexecutorconfiguration-maxconcurrency */ readonly maxConcurrency: number; /** * A map of output bindings that controls which bindings the executor commits to the session state after all child functions complete. * * Each key is a namespaced output path, and each value is an expression that MediaTailor evaluates against the combined results of the child functions. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-concurrentexecutorconfiguration.html#cfn-mediatailor-function-concurrentexecutorconfiguration-output */ readonly output: cdk.IResolvable | Record; /** * The expression language used to evaluate expressions in the function configuration. * * Set this to JSONATA. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-concurrentexecutorconfiguration.html#cfn-mediatailor-function-concurrentexecutorconfiguration-runtime */ readonly runtime: string; /** * The maximum time, in milliseconds, for all child functions to complete. * * This timeout covers every function in the list, including any HTTP calls the child functions make. If the executor exceeds this timeout, MediaTailor discards all output from the executor and proceeds with default behavior. Valid values are 100 to 2000. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-concurrentexecutorconfiguration.html#cfn-mediatailor-function-concurrentexecutorconfiguration-timeoutmilliseconds */ readonly timeoutMilliseconds: number; } /** * A reference to a child function within an executor function. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-functionref.html */ interface FunctionRefProperty { /** * An optional alternate name for the child function within the executor. * * MediaTailor uses this value as the namespace for the child function's output. If omitted, MediaTailor uses the function identifier. The resolved namespace must be unique across all child functions in the list. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-functionref.html#cfn-mediatailor-function-functionref-alias */ readonly alias?: string; /** * The identifier of the child function to execute. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-functionref.html#cfn-mediatailor-function-functionref-functionid */ readonly functionId?: string; /** * An optional expression that evaluates to a boolean. * * MediaTailor evaluates this expression immediately before running the child function, using the accumulated state at that point. If the expression evaluates to false, MediaTailor skips the child function. If omitted, the child function always runs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-functionref.html#cfn-mediatailor-function-functionref-runcondition */ readonly runCondition?: string; } /** * The configuration for a SEQUENTIAL_EXECUTOR function. * * A SEQUENTIAL_EXECUTOR runs an ordered list of child functions one at a time, passing data between them. For more information about functions, see Working with functions (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions.html) in the MediaTailor User Guide. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html */ interface SequentialExecutorConfigurationProperty { /** * An ordered list of 1 to 10 steps. * * Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes the steps in order, passing data between steps through temporary data. Each step's resolved namespace must be unique across the list. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html#cfn-mediatailor-function-sequentialexecutorconfiguration-functionlist */ readonly functionList: Array | cdk.IResolvable; /** * A map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. * * Each key is a namespaced output path, and each value is an expression that MediaTailor evaluates against the accumulated results of the steps. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html#cfn-mediatailor-function-sequentialexecutorconfiguration-output */ readonly output?: cdk.IResolvable | Record; /** * The expression language used to evaluate expressions in the function configuration. * * Set this to JSONATA. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html#cfn-mediatailor-function-sequentialexecutorconfiguration-runtime */ readonly runtime: string; /** * The maximum time, in milliseconds, for the entire sequence to complete. * * This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior. Valid values are 100 to 2000. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-sequentialexecutorconfiguration.html#cfn-mediatailor-function-sequentialexecutorconfiguration-timeoutmilliseconds */ readonly timeoutMilliseconds: number; } /** * The configuration for a VAST_REQUEST function. * * Specifies the HTTP method, URL, headers, body, timeout, and output expressions for a request to a VAST endpoint. MediaTailor parses the response as VAST and resolves wrapper redirects, then makes the parsed ads available to the function's output expressions. For more information, see Function types and composition (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types.html) in the MediaTailor User Guide. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-vastrequestconfiguration.html */ interface VastRequestConfigurationProperty { /** * An expression that evaluates to the request body, for example to send an OpenRTB bid request. * * The expression can be up to 100,000 characters, and the body after evaluation can be up to 64 KB. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-vastrequestconfiguration.html#cfn-mediatailor-function-vastrequestconfiguration-body */ readonly body?: string; /** * A map of HTTP header names to expression values. * * MediaTailor evaluates each header value expression at runtime and includes the result in the outbound request. Headers beginning with X-Amz- are reserved by the service, and method override headers are not allowed. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-vastrequestconfiguration.html#cfn-mediatailor-function-vastrequestconfiguration-headers */ readonly headers?: cdk.IResolvable | Record; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-vastrequestconfiguration.html#cfn-mediatailor-function-vastrequestconfiguration-methodtype */ readonly methodType: string; /** * A map of output bindings. * * Each key is a namespaced output path (such as temp.wrappedAds), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in a VAST_REQUEST function can reference the response object, which exposes response.parsedAds, the ads parsed from the VAST response after schema validation and wrapper resolution, and response.statusCode. For more information about expression syntax, see JSONata expression reference (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-jsonata.html) in the MediaTailor User Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-vastrequestconfiguration.html#cfn-mediatailor-function-vastrequestconfiguration-output */ readonly output?: cdk.IResolvable | Record; /** * The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint. * * The timeout covers the entire response, including any wrapper redirects that MediaTailor follows. If the call exceeds this timeout, MediaTailor proceeds with an empty ad list and continues output expression evaluation. Valid values are 100 to 2000. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-vastrequestconfiguration.html#cfn-mediatailor-function-vastrequestconfiguration-requesttimeoutmilliseconds */ readonly requestTimeoutMilliseconds: number; /** * The expression language used to evaluate expressions in the function configuration. * * Set this to JSONATA. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-vastrequestconfiguration.html#cfn-mediatailor-function-vastrequestconfiguration-runtime */ readonly runtime: string; /** * An expression that evaluates to the VAST endpoint URL. * * Use {%...%} delimiters for dynamic expressions. A literal value must be an https:// URL. The expression can be up to 25,000 characters, and the URL after evaluation can be up to 2,048 characters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-function-vastrequestconfiguration.html#cfn-mediatailor-function-vastrequestconfiguration-url */ readonly url: string; } } /** * Properties for defining a `CfnFunction` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html */ export interface CfnFunctionProps { /** * The configuration for an AWS_SERVICE_REQUEST function. * * Contains the target service, target Region, and request parameters that the function uses to call an AWS service API. For more information, see AWS_SERVICE_REQUEST (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types-aws-service-request.html) in the MediaTailor User Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-awsservicerequestconfiguration */ readonly awsServiceRequestConfiguration?: CfnFunction.AwsServiceRequestConfigurationProperty | cdk.IResolvable; /** * The configuration for a CONCURRENT_EXECUTOR function. * * A CONCURRENT_EXECUTOR runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete. For more information about functions, see Working with functions (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions.html) in the MediaTailor User Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-concurrentexecutorconfiguration */ readonly concurrentExecutorConfiguration?: CfnFunction.ConcurrentExecutorConfigurationProperty | cdk.IResolvable; /** * Configuration for custom output functions. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-customoutputconfiguration */ readonly customOutputConfiguration?: CfnFunction.CustomOutputConfigurationProperty | cdk.IResolvable; /** * A description of the function. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-description */ readonly description?: string; /** * The unique identifier for the function. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-functionid */ readonly functionId: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-functiontype */ readonly functionType: string; /** * Configuration for HTTP request functions. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-httprequestconfiguration */ readonly httpRequestConfiguration?: CfnFunction.HttpRequestConfigurationProperty | cdk.IResolvable; /** * The configuration for a SEQUENTIAL_EXECUTOR function. * * A SEQUENTIAL_EXECUTOR runs an ordered list of child functions one at a time, passing data between them. For more information about functions, see Working with functions (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions.html) in the MediaTailor User Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-sequentialexecutorconfiguration */ readonly sequentialExecutorConfiguration?: cdk.IResolvable | CfnFunction.SequentialExecutorConfigurationProperty; /** * The tags to assign to the function resource. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-tags */ readonly tags?: Array; /** * The configuration for a VAST_REQUEST function. * * Specifies the HTTP method, URL, headers, body, timeout, and output expressions for a request to a VAST endpoint. MediaTailor parses the response as VAST and resolves wrapper redirects, then makes the parsed ads available to the function's output expressions. For more information, see Function types and composition (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types.html) in the MediaTailor User Guide. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-vastrequestconfiguration */ readonly vastRequestConfiguration?: cdk.IResolvable | CfnFunction.VastRequestConfigurationProperty; } /** * Definition of AWS::MediaTailor::PrefetchSchedule Resource Type. * * @cloudformationResource AWS::MediaTailor::PrefetchSchedule * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html */ export declare class CfnPrefetchSchedule extends cdk.CfnResource implements cdk.IInspectable, IPrefetchScheduleRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnPrefetchSchedule from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPrefetchSchedule; /** * Checks whether the given object is a CfnPrefetchSchedule */ static isCfnPrefetchSchedule(x: any): x is CfnPrefetchSchedule; static arnForPrefetchSchedule(resource: IPrefetchScheduleRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; private _consumption?; /** * The name to assign to the prefetch schedule. */ private _name; /** * The name of the playback configuration. */ private _playbackConfigurationName; private _recurringPrefetchConfiguration?; private _retrieval?; /** * The frequency that MediaTailor creates prefetch schedules. */ private _scheduleType?; /** * An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. */ private _streamId?; /** * The tags assigned to the prefetch schedule. */ private _tags?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::MediaTailor::PrefetchSchedule`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnPrefetchScheduleProps); get prefetchScheduleRef(): PrefetchScheduleReference; get consumption(): cdk.IResolvable | CfnPrefetchSchedule.PrefetchConsumptionProperty | undefined; set consumption(value: cdk.IResolvable | CfnPrefetchSchedule.PrefetchConsumptionProperty | undefined); /** * The name to assign to the prefetch schedule. */ get name(): string; /** * The name to assign to the prefetch schedule. */ set name(value: string); /** * The name of the playback configuration. */ get playbackConfigurationName(): string; /** * The name of the playback configuration. */ set playbackConfigurationName(value: string); get recurringPrefetchConfiguration(): cdk.IResolvable | CfnPrefetchSchedule.RecurringPrefetchConfigurationProperty | undefined; set recurringPrefetchConfiguration(value: cdk.IResolvable | CfnPrefetchSchedule.RecurringPrefetchConfigurationProperty | undefined); get retrieval(): cdk.IResolvable | CfnPrefetchSchedule.PrefetchRetrievalProperty | undefined; set retrieval(value: cdk.IResolvable | CfnPrefetchSchedule.PrefetchRetrievalProperty | undefined); /** * The frequency that MediaTailor creates prefetch schedules. */ get scheduleType(): string | undefined; /** * The frequency that MediaTailor creates prefetch schedules. */ set scheduleType(value: string | undefined); /** * An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. */ get streamId(): string | undefined; /** * An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. */ set streamId(value: string | undefined); /** * The tags assigned to the prefetch schedule. */ get tags(): Array | undefined; /** * The tags assigned to the prefetch schedule. */ set tags(value: Array | undefined); /** * The Amazon Resource Name (ARN) of the prefetch schedule. * * @cloudformationAttribute Arn */ get attrArn(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnPrefetchSchedule { /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchconsumption.html */ interface PrefetchConsumptionProperty { /** * If you only want MediaTailor to insert prefetched ads into avails that match specific dynamic variables, set the avail matching criteria. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchconsumption.html#cfn-mediatailor-prefetchschedule-prefetchconsumption-availmatchingcriteria */ readonly availMatchingCriteria?: Array | cdk.IResolvable; /** * The time when MediaTailor no longer considers the prefetched ads for use in an ad break, as an ISO 8601 date-time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchconsumption.html#cfn-mediatailor-prefetchschedule-prefetchconsumption-endtime */ readonly endTime: string; /** * The time when prefetched ads are considered for use in an ad break, as an ISO 8601 date-time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchconsumption.html#cfn-mediatailor-prefetchschedule-prefetchconsumption-starttime */ readonly startTime?: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-availmatchingcriteria.html */ interface AvailMatchingCriteriaProperty { /** * The dynamic variable(s) that MediaTailor should use as avail matching criteria. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-availmatchingcriteria.html#cfn-mediatailor-prefetchschedule-availmatchingcriteria-dynamicvariable */ readonly dynamicVariable: string; /** * For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-availmatchingcriteria.html#cfn-mediatailor-prefetchschedule-availmatchingcriteria-operator */ readonly operator: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html */ interface PrefetchRetrievalProperty { /** * The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-dynamicvariables */ readonly dynamicVariables?: cdk.IResolvable | Record; /** * The time when prefetch retrieval ends for the ad break, as an ISO 8601 date-time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-endtime */ readonly endTime: string; /** * The time when prefetch retrievals can start for this break, as an ISO 8601 date-time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-starttime */ readonly startTime?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-trafficshapingretrievalwindow */ readonly trafficShapingRetrievalWindow?: cdk.IResolvable | CfnPrefetchSchedule.TrafficShapingRetrievalWindowProperty; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-trafficshapingtpsconfiguration */ readonly trafficShapingTpsConfiguration?: cdk.IResolvable | CfnPrefetchSchedule.TrafficShapingTpsConfigurationProperty; /** * Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-prefetchretrieval.html#cfn-mediatailor-prefetchschedule-prefetchretrieval-trafficshapingtype */ readonly trafficShapingType?: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-trafficshapingretrievalwindow.html */ interface TrafficShapingRetrievalWindowProperty { /** * The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-trafficshapingretrievalwindow.html#cfn-mediatailor-prefetchschedule-trafficshapingretrievalwindow-retrievalwindowdurationseconds */ readonly retrievalWindowDurationSeconds?: number; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-trafficshapingtpsconfiguration.html */ interface TrafficShapingTpsConfigurationProperty { /** * The expected peak number of concurrent viewers for your content. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-trafficshapingtpsconfiguration.html#cfn-mediatailor-prefetchschedule-trafficshapingtpsconfiguration-peakconcurrentusers */ readonly peakConcurrentUsers?: number; /** * The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-trafficshapingtpsconfiguration.html#cfn-mediatailor-prefetchschedule-trafficshapingtpsconfiguration-peaktps */ readonly peakTps?: number; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringprefetchconfiguration.html */ interface RecurringPrefetchConfigurationProperty { /** * The end time for the window that MediaTailor prefetches and inserts ads in a live event, as an ISO 8601 date-time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringprefetchconfiguration.html#cfn-mediatailor-prefetchschedule-recurringprefetchconfiguration-endtime */ readonly endTime: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringprefetchconfiguration.html#cfn-mediatailor-prefetchschedule-recurringprefetchconfiguration-recurringconsumption */ readonly recurringConsumption: cdk.IResolvable | CfnPrefetchSchedule.RecurringConsumptionProperty; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringprefetchconfiguration.html#cfn-mediatailor-prefetchschedule-recurringprefetchconfiguration-recurringretrieval */ readonly recurringRetrieval: cdk.IResolvable | CfnPrefetchSchedule.RecurringRetrievalProperty; /** * The start time for the window that MediaTailor prefetches and inserts ads in a live event, as an ISO 8601 date-time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringprefetchconfiguration.html#cfn-mediatailor-prefetchschedule-recurringprefetchconfiguration-starttime */ readonly startTime?: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringconsumption.html */ interface RecurringConsumptionProperty { /** * The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringconsumption.html#cfn-mediatailor-prefetchschedule-recurringconsumption-availmatchingcriteria */ readonly availMatchingCriteria?: Array | cdk.IResolvable; /** * The number of seconds that an ad is available for insertion after it was prefetched. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringconsumption.html#cfn-mediatailor-prefetchschedule-recurringconsumption-retrievedadexpirationseconds */ readonly retrievedAdExpirationSeconds?: number; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringretrieval.html */ interface RecurringRetrievalProperty { /** * The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringretrieval.html#cfn-mediatailor-prefetchschedule-recurringretrieval-delayafteravailendseconds */ readonly delayAfterAvailEndSeconds?: number; /** * The dynamic variables to use for substitution during prefetch requests to the ADS. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringretrieval.html#cfn-mediatailor-prefetchschedule-recurringretrieval-dynamicvariables */ readonly dynamicVariables?: cdk.IResolvable | Record; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringretrieval.html#cfn-mediatailor-prefetchschedule-recurringretrieval-trafficshapingretrievalwindow */ readonly trafficShapingRetrievalWindow?: cdk.IResolvable | CfnPrefetchSchedule.TrafficShapingRetrievalWindowProperty; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringretrieval.html#cfn-mediatailor-prefetchschedule-recurringretrieval-trafficshapingtpsconfiguration */ readonly trafficShapingTpsConfiguration?: cdk.IResolvable | CfnPrefetchSchedule.TrafficShapingTpsConfigurationProperty; /** * Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-prefetchschedule-recurringretrieval.html#cfn-mediatailor-prefetchschedule-recurringretrieval-trafficshapingtype */ readonly trafficShapingType?: string; } } /** * Properties for defining a `CfnPrefetchSchedule` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html */ export interface CfnPrefetchScheduleProps { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-consumption */ readonly consumption?: cdk.IResolvable | CfnPrefetchSchedule.PrefetchConsumptionProperty; /** * The name to assign to the prefetch schedule. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-name */ readonly name: string; /** * The name of the playback configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-playbackconfigurationname */ readonly playbackConfigurationName: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-recurringprefetchconfiguration */ readonly recurringPrefetchConfiguration?: cdk.IResolvable | CfnPrefetchSchedule.RecurringPrefetchConfigurationProperty; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-retrieval */ readonly retrieval?: cdk.IResolvable | CfnPrefetchSchedule.PrefetchRetrievalProperty; /** * The frequency that MediaTailor creates prefetch schedules. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-scheduletype */ readonly scheduleType?: string; /** * An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-streamid */ readonly streamId?: string; /** * The tags assigned to the prefetch schedule. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-prefetchschedule.html#cfn-mediatailor-prefetchschedule-tags */ readonly tags?: Array; } /** * Resource schema for AWS::MediaTailor::Program. * * @cloudformationResource AWS::MediaTailor::Program * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html */ export declare class CfnProgram extends cdk.CfnResource implements cdk.IInspectable, IProgramRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnProgram from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnProgram; /** * Checks whether the given object is a CfnProgram */ static isCfnProgram(x: any): x is CfnProgram; static arnForProgram(resource: IProgramRef): string; /** * The ad break configuration settings. */ private _adBreaks?; /** * The list of AudienceMedia defined in program. */ private _audienceMedia?; /** * The name of the channel for this Program. */ private _channelName; /** * The name of the LiveSource for this Program. */ private _liveSourceName?; /** * The name of the Program. */ private _programName; /** * Schedule configuration parameters. */ private _scheduleConfiguration?; /** * The name of the source location. */ private _sourceLocationName; /** * The name that's used to refer to a VOD source. */ private _vodSourceName?; protected readonly cfnPropertyNames: Record; /** * Create a new `AWS::MediaTailor::Program`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnProgramProps); get programRef(): ProgramReference; /** * The ad break configuration settings. */ get adBreaks(): Array | cdk.IResolvable | undefined; /** * The ad break configuration settings. */ set adBreaks(value: Array | cdk.IResolvable | undefined); /** * The list of AudienceMedia defined in program. */ get audienceMedia(): Array | cdk.IResolvable | undefined; /** * The list of AudienceMedia defined in program. */ set audienceMedia(value: Array | cdk.IResolvable | undefined); /** * The name of the channel for this Program. */ get channelName(): string; /** * The name of the channel for this Program. */ set channelName(value: string); /** * The name of the LiveSource for this Program. */ get liveSourceName(): string | undefined; /** * The name of the LiveSource for this Program. */ set liveSourceName(value: string | undefined); /** * The name of the Program. */ get programName(): string; /** * The name of the Program. */ set programName(value: string); /** * Schedule configuration parameters. */ get scheduleConfiguration(): cdk.IResolvable | CfnProgram.ScheduleConfigurationProperty | undefined; /** * Schedule configuration parameters. */ set scheduleConfiguration(value: cdk.IResolvable | CfnProgram.ScheduleConfigurationProperty | undefined); /** * The name of the source location. */ get sourceLocationName(): string; /** * The name of the source location. */ set sourceLocationName(value: string); /** * The name that's used to refer to a VOD source. */ get vodSourceName(): string | undefined; /** * The name that's used to refer to a VOD source. */ set vodSourceName(value: string | undefined); /** * The ARN of the program. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * Clip range configuration for the VOD source associated with the program. * * @cloudformationAttribute ClipRange */ get attrClipRange(): cdk.IResolvable; /** * The timestamp of when the program was created. * * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * The duration of the live program in milliseconds. * * @cloudformationAttribute DurationMillis */ get attrDurationMillis(): number; /** * The date and time that the program is scheduled to start. * * @cloudformationAttribute ScheduledStartTime */ get attrScheduledStartTime(): string; protected get cfnProperties(): Record; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record): Record; } export declare namespace CfnProgram { /** * Ad break configuration parameters. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html */ interface AdBreakProperty { /** * Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET tag for SCTE35_ENHANCED output. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-adbreakmetadata */ readonly adBreakMetadata?: Array | cdk.IResolvable; /** * The SCTE-35 ad insertion type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-messagetype */ readonly messageType?: string; /** * How long (in milliseconds) after the beginning of the program that an ad starts. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-offsetmillis */ readonly offsetMillis: number; /** * Slate VOD source configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-slate */ readonly slate?: cdk.IResolvable | CfnProgram.SlateSourceProperty; /** * Splice insert message configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-spliceinsertmessage */ readonly spliceInsertMessage?: cdk.IResolvable | CfnProgram.SpliceInsertMessageProperty; /** * The SCTE-35 time_signal message configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-timesignalmessage */ readonly timeSignalMessage?: cdk.IResolvable | CfnProgram.TimeSignalMessageProperty; } /** * For SCTE35_ENHANCED output, defines a key and corresponding value. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-keyvaluepair.html */ interface KeyValuePairProperty { /** * The key. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-keyvaluepair.html#cfn-mediatailor-program-keyvaluepair-key */ readonly key: string; /** * The value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-keyvaluepair.html#cfn-mediatailor-program-keyvaluepair-value */ readonly value: string; } /** * Slate VOD source configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-slatesource.html */ interface SlateSourceProperty { /** * The name of the source location where the slate VOD source is stored. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-slatesource.html#cfn-mediatailor-program-slatesource-sourcelocationname */ readonly sourceLocationName?: string; /** * The slate VOD source name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-slatesource.html#cfn-mediatailor-program-slatesource-vodsourcename */ readonly vodSourceName?: string; } /** * Splice insert message configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.html */ interface SpliceInsertMessageProperty { /** * This is written to splice_insert.avail_num. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.html#cfn-mediatailor-program-spliceinsertmessage-availnum */ readonly availNum?: number; /** * This is written to splice_insert.avails_expected. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.html#cfn-mediatailor-program-spliceinsertmessage-availsexpected */ readonly availsExpected?: number; /** * This is written to splice_insert.splice_event_id. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.html#cfn-mediatailor-program-spliceinsertmessage-spliceeventid */ readonly spliceEventId?: number; /** * This is written to splice_insert.unique_program_id. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-spliceinsertmessage.html#cfn-mediatailor-program-spliceinsertmessage-uniqueprogramid */ readonly uniqueProgramId?: number; } /** * The SCTE-35 time_signal message configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-timesignalmessage.html */ interface TimeSignalMessageProperty { /** * The configurations for the SCTE-35 segmentation_descriptor message(s). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-timesignalmessage.html#cfn-mediatailor-program-timesignalmessage-segmentationdescriptors */ readonly segmentationDescriptors?: Array | cdk.IResolvable; } /** * The segmentation_descriptor message configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html */ interface SegmentationDescriptorProperty { /** * The Event Identifier to assign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentationeventid */ readonly segmentationEventId?: number; /** * The Type Identifier to assign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentationtypeid */ readonly segmentationTypeId?: number; /** * The Upid to assign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentationupid */ readonly segmentationUpid?: string; /** * The Upid Type to assign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentationupidtype */ readonly segmentationUpidType?: number; /** * The segment number to assign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentnum */ readonly segmentNum?: number; /** * The number of segments expected. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-segmentsexpected */ readonly segmentsExpected?: number; /** * The sub-segment number to assign. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-subsegmentnum */ readonly subSegmentNum?: number; /** * The number of sub-segments expected. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-segmentationdescriptor.html#cfn-mediatailor-program-segmentationdescriptor-subsegmentsexpected */ readonly subSegmentsExpected?: number; } /** * An AudienceMedia object contains an Audience and a list of AlternateMedia. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-audiencemedia.html */ interface AudienceMediaProperty { /** * The list of AlternateMedia defined in AudienceMedia. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-audiencemedia.html#cfn-mediatailor-program-audiencemedia-alternatemedia */ readonly alternateMedia?: Array | cdk.IResolvable; /** * The Audience defined in AudienceMedia. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-audiencemedia.html#cfn-mediatailor-program-audiencemedia-audience */ readonly audience?: string; } /** * A playlist of media to be played instead of the default media on a particular program. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html */ interface AlternateMediaProperty { /** * Ad break configuration parameters defined in AlternateMedia. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-adbreaks */ readonly adBreaks?: Array | cdk.IResolvable; /** * Clip range configuration for the VOD source associated with the program. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-cliprange */ readonly clipRange?: CfnProgram.ClipRangeProperty | cdk.IResolvable; /** * The duration of the alternateMedia in milliseconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-durationmillis */ readonly durationMillis?: number; /** * The name of the live source for alternateMedia. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-livesourcename */ readonly liveSourceName?: string; /** * The date and time that the alternateMedia is scheduled to start, in epoch milliseconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-scheduledstarttimemillis */ readonly scheduledStartTimeMillis?: number; /** * The name of the source location for alternateMedia. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-sourcelocationname */ readonly sourceLocationName?: string; /** * The name of the VOD source for alternateMedia. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-alternatemedia.html#cfn-mediatailor-program-alternatemedia-vodsourcename */ readonly vodSourceName?: string; } /** * Clip range configuration for the VOD source associated with the program. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-cliprange.html */ interface ClipRangeProperty { /** * The end offset of the clip range, in milliseconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-cliprange.html#cfn-mediatailor-program-cliprange-endoffsetmillis */ readonly endOffsetMillis?: number; /** * The start offset of the clip range, in milliseconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-cliprange.html#cfn-mediatailor-program-cliprange-startoffsetmillis */ readonly startOffsetMillis?: number; } /** * Schedule configuration parameters. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-scheduleconfiguration.html */ interface ScheduleConfigurationProperty { /** * Clip range configuration for the VOD source associated with the program. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-scheduleconfiguration.html#cfn-mediatailor-program-scheduleconfiguration-cliprange */ readonly clipRange?: CfnProgram.ClipRangeProperty | cdk.IResolvable; /** * Program transition configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-scheduleconfiguration.html#cfn-mediatailor-program-scheduleconfiguration-transition */ readonly transition: cdk.IResolvable | CfnProgram.TransitionProperty; } /** * Program transition configuration. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-transition.html */ interface TransitionProperty { /** * The duration of the live program in seconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-transition.html#cfn-mediatailor-program-transition-durationmillis */ readonly durationMillis?: number; /** * The position where this program will be inserted relative to the RelativePosition. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-transition.html#cfn-mediatailor-program-transition-relativeposition */ readonly relativePosition: string; /** * The name of the program that this program will be inserted next to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-transition.html#cfn-mediatailor-program-transition-relativeprogram */ readonly relativeProgram?: string; /** * The date and time that the program is scheduled to start, in epoch milliseconds. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-transition.html#cfn-mediatailor-program-transition-scheduledstarttimemillis */ readonly scheduledStartTimeMillis?: number; /** * Defines when the program plays in the schedule. * * You can set the value to ABSOLUTE or RELATIVE. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-transition.html#cfn-mediatailor-program-transition-type */ readonly type: string; } } /** * Properties for defining a `CfnProgram` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html */ export interface CfnProgramProps { /** * The ad break configuration settings. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-adbreaks */ readonly adBreaks?: Array | cdk.IResolvable; /** * The list of AudienceMedia defined in program. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-audiencemedia */ readonly audienceMedia?: Array | cdk.IResolvable; /** * The name of the channel for this Program. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-channelname */ readonly channelName: string; /** * The name of the LiveSource for this Program. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-livesourcename */ readonly liveSourceName?: string; /** * The name of the Program. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-programname */ readonly programName: string; /** * Schedule configuration parameters. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-scheduleconfiguration */ readonly scheduleConfiguration?: cdk.IResolvable | CfnProgram.ScheduleConfigurationProperty; /** * The name of the source location. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-sourcelocationname */ readonly sourceLocationName: string; /** * The name that's used to refer to a VOD source. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.html#cfn-mediatailor-program-vodsourcename */ readonly vodSourceName?: string; } export type { IChannelRef, ChannelReference }; export type { IChannelPolicyRef, ChannelPolicyReference }; export type { ILiveSourceRef, LiveSourceReference }; export type { IPlaybackConfigurationRef, PlaybackConfigurationReference }; export type { ISourceLocationRef, SourceLocationReference }; export type { IVodSourceRef, VodSourceReference }; export type { IFunctionRef, FunctionReference }; export type { IPrefetchScheduleRef, PrefetchScheduleReference }; export type { IProgramRef, ProgramReference };