Class CfnPlaybackConfiguration

Adds a new playback configuration to AWS Elemental MediaTailor .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnPlaybackConfiguration

Implements

IInspectable

IPlaybackConfigurationRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.MediaTailor

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPlaybackConfiguration : CfnResource, IInspectable, IPlaybackConfigurationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnPlaybackConfiguration Inherits CfnResource Implements IInspectable, IPlaybackConfigurationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.MediaTailor;

             var configurationAliases;

             var cfnPlaybackConfiguration = new CfnPlaybackConfiguration(this, "MyCfnPlaybackConfiguration", new CfnPlaybackConfigurationProps {
                 AdDecisionServerUrl = "adDecisionServerUrl",
                 Name = "name",
                 VideoContentSourceUrl = "videoContentSourceUrl",

                 // the properties below are optional
                 AdConditioningConfiguration = new AdConditioningConfigurationProperty {
                     StreamingMediaFileConditioning = "streamingMediaFileConditioning"
                 },
                 AvailSuppression = new AvailSuppressionProperty {
                     FillPolicy = "fillPolicy",
                     Mode = "mode",
                     Value = "value"
                 },
                 Bumper = new BumperProperty {
                     EndUrl = "endUrl",
                     StartUrl = "startUrl"
                 },
                 CdnConfiguration = new CdnConfigurationProperty {
                     AdSegmentUrlPrefix = "adSegmentUrlPrefix",
                     ContentSegmentUrlPrefix = "contentSegmentUrlPrefix"
                 },
                 ConfigurationAliases = new Dictionary<string, object> {
                     { "configurationAliasesKey", configurationAliases }
                 },
                 DashConfiguration = new DashConfigurationProperty {
                     ManifestEndpointPrefix = "manifestEndpointPrefix",
                     MpdLocation = "mpdLocation",
                     OriginManifestType = "originManifestType"
                 },
                 HlsConfiguration = new HlsConfigurationProperty {
                     ManifestEndpointPrefix = "manifestEndpointPrefix"
                 },
                 InsertionMode = "insertionMode",
                 LivePreRollConfiguration = new LivePreRollConfigurationProperty {
                     AdDecisionServerUrl = "adDecisionServerUrl",
                     MaxDurationSeconds = 123
                 },
                 LogConfiguration = new LogConfigurationProperty {
                     PercentEnabled = 123,

                     // the properties below are optional
                     AdsInteractionLog = new AdsInteractionLogProperty {
                         ExcludeEventTypes = new [] { "excludeEventTypes" },
                         PublishOptInEventTypes = new [] { "publishOptInEventTypes" }
                     },
                     EnabledLoggingStrategies = new [] { "enabledLoggingStrategies" },
                     ManifestServiceInteractionLog = new ManifestServiceInteractionLogProperty {
                         ExcludeEventTypes = new [] { "excludeEventTypes" }
                     }
                 },
                 ManifestProcessingRules = new ManifestProcessingRulesProperty {
                     AdMarkerPassthrough = new AdMarkerPassthroughProperty {
                         Enabled = false
                     }
                 },
                 PersonalizationThresholdSeconds = 123,
                 SlateAdUrl = "slateAdUrl",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TranscodeProfileName = "transcodeProfileName"
             });

Synopsis

Constructors

CfnPlaybackConfiguration(Construct, string, ICfnPlaybackConfigurationProps)

Adds a new playback configuration to AWS Elemental MediaTailor .

Properties

AdConditioningConfiguration	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.
AdDecisionServerUrl	The URL for the ad decision server (ADS).
AttrDashConfigurationManifestEndpointPrefix	The URL generated by MediaTailor to initiate a playback session.
AttrHlsConfigurationManifestEndpointPrefix	The URL that is used to initiate a playback session for devices that support Apple HLS.
AttrPlaybackConfigurationArn	The Amazon Resource Name (ARN) for the playback configuration.
AttrPlaybackEndpointPrefix	The URL that the player accesses to get a manifest from MediaTailor .
AttrSessionInitializationEndpointPrefix	The URL that the player uses to initialize a session that uses client-side reporting.
AvailSuppression	The configuration for avail suppression, also known as ad suppression.
Bumper	The configuration for bumpers.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdnConfiguration	The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
CfnProperties	Adds a new playback configuration to AWS Elemental MediaTailor .
ConfigurationAliases	The player parameters and aliases used as dynamic variables during session initialization.
DashConfiguration	The configuration for a DASH source.
HlsConfiguration	The configuration for HLS content.
InsertionMode	The setting that controls whether players can use stitched or guided ad insertion.
LivePreRollConfiguration	The configuration for pre-roll ad insertion.
LogConfiguration	Defines where AWS Elemental MediaTailor sends logs for the playback configuration.
ManifestProcessingRules	The configuration for manifest processing rules.
Name	The identifier for the playback configuration.
PersonalizationThresholdSeconds	Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.
PlaybackConfigurationRef	A reference to a PlaybackConfiguration resource.
SlateAdUrl	The URL for a video asset to transcode and use to fill in time that's not used by ads.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The tags to assign to the playback configuration.
TranscodeProfileName	The name that is used to associate this playback configuration with a custom transcode profile.
VideoContentSourceUrl	The URL prefix for the parent manifest for the stream, minus the asset ID.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Adds a new playback configuration to AWS Elemental MediaTailor .

Constructors

CfnPlaybackConfiguration(Construct, string, ICfnPlaybackConfigurationProps)

Adds a new playback configuration to AWS Elemental MediaTailor .

public CfnPlaybackConfiguration(Construct scope, string id, ICfnPlaybackConfigurationProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnPlaybackConfigurationProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

Properties

AdConditioningConfiguration

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.

public virtual object? AdConditioningConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPlaybackConfiguration.IAdConditioningConfigurationProperty

AdDecisionServerUrl

The URL for the ad decision server (ADS).

public virtual string AdDecisionServerUrl { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

AttrDashConfigurationManifestEndpointPrefix

The URL generated by MediaTailor to initiate a playback session.

public virtual string AttrDashConfigurationManifestEndpointPrefix { get; }

Property Value

string

Remarks

The session uses server-side reporting. This setting is ignored in PUT operations.

CloudformationAttribute: DashConfiguration.ManifestEndpointPrefix

AttrHlsConfigurationManifestEndpointPrefix

The URL that is used to initiate a playback session for devices that support Apple HLS.

public virtual string AttrHlsConfigurationManifestEndpointPrefix { get; }

Property Value

string

Remarks

The session uses server-side reporting.

CloudformationAttribute: HlsConfiguration.ManifestEndpointPrefix

AttrPlaybackConfigurationArn

The Amazon Resource Name (ARN) for the playback configuration.

public virtual string AttrPlaybackConfigurationArn { get; }

Property Value

string

Remarks

CloudformationAttribute: PlaybackConfigurationArn

AttrPlaybackEndpointPrefix

The URL that the player accesses to get a manifest from MediaTailor .

public virtual string AttrPlaybackEndpointPrefix { get; }

Property Value

string

Remarks

This session will use server-side reporting.

CloudformationAttribute: PlaybackEndpointPrefix

AttrSessionInitializationEndpointPrefix

The URL that the player uses to initialize a session that uses client-side reporting.

public virtual string AttrSessionInitializationEndpointPrefix { get; }

Property Value

string

Remarks

CloudformationAttribute: SessionInitializationEndpointPrefix

AvailSuppression

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

public virtual object? AvailSuppression { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPlaybackConfiguration.IAvailSuppressionProperty

Bumper

The configuration for bumpers.

public virtual object? Bumper { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPlaybackConfiguration.IBumperProperty

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

CdnConfiguration

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

public virtual object? CdnConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPlaybackConfiguration.ICdnConfigurationProperty

CfnProperties

Adds a new playback configuration to AWS Elemental MediaTailor .

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

ConfigurationAliases

The player parameters and aliases used as dynamic variables during session initialization.

public virtual object? ConfigurationAliases { get; set; }

Property Value

object

Remarks

Type union: either Dictionary<string, object> or IResolvable

DashConfiguration

The configuration for a DASH source.

public virtual object? DashConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPlaybackConfiguration.IDashConfigurationProperty

HlsConfiguration

The configuration for HLS content.

public virtual object? HlsConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPlaybackConfiguration.IHlsConfigurationProperty

InsertionMode

The setting that controls whether players can use stitched or guided ad insertion.

public virtual string? InsertionMode { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

LivePreRollConfiguration

The configuration for pre-roll ad insertion.

public virtual object? LivePreRollConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPlaybackConfiguration.ILivePreRollConfigurationProperty

LogConfiguration

Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

public virtual object? LogConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPlaybackConfiguration.ILogConfigurationProperty

ManifestProcessingRules

The configuration for manifest processing rules.

public virtual object? ManifestProcessingRules { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPlaybackConfiguration.IManifestProcessingRulesProperty

Name

The identifier for the playback configuration.

public virtual string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

PersonalizationThresholdSeconds

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.

public virtual double? PersonalizationThresholdSeconds { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

PlaybackConfigurationRef

A reference to a PlaybackConfiguration resource.

public virtual IPlaybackConfigurationReference PlaybackConfigurationRef { get; }

Property Value

IPlaybackConfigurationReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

SlateAdUrl

The URL for a video asset to transcode and use to fill in time that's not used by ads.

public virtual string? SlateAdUrl { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

TagsRaw

The tags to assign to the playback configuration.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

TranscodeProfileName

The name that is used to associate this playback configuration with a custom transcode profile.

public virtual string? TranscodeProfileName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

VideoContentSourceUrl

The URL prefix for the parent manifest for the stream, minus the asset ID.

public virtual string VideoContentSourceUrl { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Adds a new playback configuration to AWS Elemental MediaTailor .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-playbackconfiguration.html

CloudformationResource: AWS::MediaTailor::PlaybackConfiguration

ExampleMetadata: fixture=_generated

Implements

IInspectable

IPlaybackConfigurationRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable