aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,125 lines • 96.3 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { ChannelPolicyReference, ChannelReference, IChannelPolicyRef, IChannelRef, ILiveSourceRef, IPlaybackConfigurationRef, ISourceLocationRef, IVodSourceRef, LiveSourceReference, PlaybackConfigurationReference, 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<string, string>;
/**
* 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<string> | undefined;
/**
* The list of audiences defined in channel.
*/
set audiences(value: Array<string> | 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 | CfnChannel.RequestOutputItemProperty> | cdk.IResolvable;
/**
* The channel's output properties.
*/
set outputs(value: Array<cdk.IResolvable | CfnChannel.RequestOutputItemProperty> | 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<cdk.CfnTag> | undefined;
/**
* The tags to assign to the channel.
*/
set tags(value: Array<cdk.CfnTag> | 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);
/**
* <p>The ARN of the channel.</p>
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
protected get cfnProperties(): Record<string, any>;
/**
* 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<string, any>): Record<string, any>;
}
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<string>;
/**
* 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<string>;
}
/**
* 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<string>;
/**
* 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 | CfnChannel.RequestOutputItemProperty> | 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<cdk.CfnTag>;
/**
* 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<string, string>;
/**
* 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<string, any>;
/**
* 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<string, any>): Record<string, any>;
}
/**
* 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<string, string>;
/**
* 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<CfnLiveSource.HttpPackageConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The HTTP package configurations for the live source.
*/
set httpPackageConfigurations(value: Array<CfnLiveSource.HttpPackageConfigurationProperty | cdk.IResolvable> | 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<cdk.CfnTag> | undefined;
/**
* The tags assigned to the live source.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* <p>The ARN of the live source.</p>
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
protected get cfnProperties(): Record<string, any>;
/**
* 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<string, any>): Record<string, any>;
}
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<CfnLiveSource.HttpPackageConfigurationProperty | cdk.IResolvable> | 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<cdk.CfnTag>;
}
/**
* 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 configuration for avail suppression, also known as ad suppression.
*/
private _availSuppression?;
/**
* 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?;
/**
* 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<string, string>;
/**
* 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 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 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<string, any | cdk.IResolvable> | undefined;
/**
* The player parameters and aliases used as dynamic variables during session initialization.
*/
set configurationAliases(value: cdk.IResolvable | Record<string, any | cdk.IResolvable> | 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);
/**
* 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<cdk.CfnTag> | undefined;
/**
* The tags to assign to the playback configuration.
*/
set tagsRaw(value: Array<cdk.CfnTag> | 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<string, any>;
/**
* 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<string, any>): Record<string, any>;
}
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. *<region>* .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 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-propertie