awsmediatailor

package
v1.168.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 9, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

README

AWS::MediaTailor Construct Library

This module is part of the AWS Cloud Development Kit project.

import mediatailor "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::MediaTailor.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnPlaybackConfiguration_CFN_RESOURCE_TYPE_NAME 

func CfnPlaybackConfiguration_CFN_RESOURCE_TYPE_NAME() *string

func CfnPlaybackConfiguration_IsCfnElement 

func CfnPlaybackConfiguration_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnPlaybackConfiguration_IsCfnResource 

func CfnPlaybackConfiguration_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPlaybackConfiguration_IsConstruct 

func CfnPlaybackConfiguration_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnPlaybackConfiguration_Override 

func NewCfnPlaybackConfiguration_Override(c CfnPlaybackConfiguration, scope awscdk.Construct, id *string, props *CfnPlaybackConfigurationProps)

Create a new `AWS::MediaTailor::PlaybackConfiguration`.

Types

type CfnPlaybackConfiguration 

type CfnPlaybackConfiguration interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The URL for the ad decision server (ADS).
	//
	// This includes the specification of static parameters and placeholders for dynamic parameters. 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.
	AdDecisionServerUrl() *string
	SetAdDecisionServerUrl(val *string)
	AttrDashConfigurationManifestEndpointPrefix() *string
	AttrHlsConfigurationManifestEndpointPrefix() *string
	AttrPlaybackConfigurationArn() *string
	AttrPlaybackEndpointPrefix() *string
	AttrSessionInitializationEndpointPrefix() *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) .
	AvailSuppression() interface{}
	SetAvailSuppression(val interface{})
	// 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) .
	Bumper() interface{}
	SetBumper(val interface{})
	// The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
	CdnConfiguration() interface{}
	SetCdnConfiguration(val interface{})
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// 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) .
	ConfigurationAliases() interface{}
	SetConfigurationAliases(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	// Experimental.
	CreationStack() *[]*string
	// The configuration for DASH content.
	DashConfiguration() interface{}
	SetDashConfiguration(val interface{})
	// The configuration for pre-roll ad insertion.
	LivePreRollConfiguration() interface{}
	SetLivePreRollConfiguration(val interface{})
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	// Experimental.
	LogicalId() *string
	// The configuration for manifest processing rules.
	//
	// Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
	ManifestProcessingRules() interface{}
	SetManifestProcessingRules(val interface{})
	// The identifier for the playback configuration.
	Name() *string
	SetName(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// 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 MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) .
	PersonalizationThresholdSeconds() *float64
	SetPersonalizationThresholdSeconds(val *float64)
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	// Experimental.
	Ref() *string
	// The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
	//
	// MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
	SlateAdUrl() *string
	SetSlateAdUrl(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// The tags to assign to the playback configuration.
	Tags() awscdk.TagManager
	// 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.
	TranscodeProfileName() *string
	SetTranscodeProfileName(val *string)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// The URL prefix for the parent manifest for the stream, minus the asset ID.
	//
	// The maximum length is 512 characters.
	VideoContentSourceUrl() *string
	SetVideoContentSourceUrl(val *string)
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::MediaTailor::PlaybackConfiguration`.

Adds a new playback configuration to AWS Elemental MediaTailor.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var configurationAliases interface{}

cfnPlaybackConfiguration := awscdk.Aws_mediatailor.NewCfnPlaybackConfiguration(this, jsii.String("MyCfnPlaybackConfiguration"), &cfnPlaybackConfigurationProps{
	adDecisionServerUrl: jsii.String("adDecisionServerUrl"),
	name: jsii.String("name"),
	videoContentSourceUrl: jsii.String("videoContentSourceUrl"),

	// the properties below are optional
	availSuppression: &availSuppressionProperty{
		mode: jsii.String("mode"),
		value: jsii.String("value"),
	},
	bumper: &bumperProperty{
		endUrl: jsii.String("endUrl"),
		startUrl: jsii.String("startUrl"),
	},
	cdnConfiguration: &cdnConfigurationProperty{
		adSegmentUrlPrefix: jsii.String("adSegmentUrlPrefix"),
		contentSegmentUrlPrefix: jsii.String("contentSegmentUrlPrefix"),
	},
	configurationAliases: map[string]interface{}{
		"configurationAliasesKey": configurationAliases,
	},
	dashConfiguration: &dashConfigurationProperty{
		manifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
		mpdLocation: jsii.String("mpdLocation"),
		originManifestType: jsii.String("originManifestType"),
	},
	livePreRollConfiguration: &livePreRollConfigurationProperty{
		adDecisionServerUrl: jsii.String("adDecisionServerUrl"),
		maxDurationSeconds: jsii.Number(123),
	},
	manifestProcessingRules: &manifestProcessingRulesProperty{
		adMarkerPassthrough: &adMarkerPassthroughProperty{
			enabled: jsii.Boolean(false),
		},
	},
	personalizationThresholdSeconds: jsii.Number(123),
	slateAdUrl: jsii.String("slateAdUrl"),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
	transcodeProfileName: jsii.String("transcodeProfileName"),
})

func NewCfnPlaybackConfiguration 

func NewCfnPlaybackConfiguration(scope awscdk.Construct, id *string, props *CfnPlaybackConfigurationProps) CfnPlaybackConfiguration

Create a new `AWS::MediaTailor::PlaybackConfiguration`.

type CfnPlaybackConfigurationProps 

type CfnPlaybackConfigurationProps struct {
	// The URL for the ad decision server (ADS).
	//
	// This includes the specification of static parameters and placeholders for dynamic parameters. 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.
	AdDecisionServerUrl *string `field:"required" json:"adDecisionServerUrl" yaml:"adDecisionServerUrl"`
	// The identifier for the playback configuration.
	Name *string `field:"required" json:"name" yaml:"name"`
	// The URL prefix for the parent manifest for the stream, minus the asset ID.
	//
	// The maximum length is 512 characters.
	VideoContentSourceUrl *string `field:"required" json:"videoContentSourceUrl" yaml:"videoContentSourceUrl"`
	// 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) .
	AvailSuppression interface{} `field:"optional" json:"availSuppression" yaml:"availSuppression"`
	// 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) .
	Bumper interface{} `field:"optional" json:"bumper" yaml:"bumper"`
	// The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
	CdnConfiguration interface{} `field:"optional" json:"cdnConfiguration" yaml:"cdnConfiguration"`
	// 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) .
	ConfigurationAliases interface{} `field:"optional" json:"configurationAliases" yaml:"configurationAliases"`
	// The configuration for DASH content.
	DashConfiguration interface{} `field:"optional" json:"dashConfiguration" yaml:"dashConfiguration"`
	// The configuration for pre-roll ad insertion.
	LivePreRollConfiguration interface{} `field:"optional" json:"livePreRollConfiguration" yaml:"livePreRollConfiguration"`
	// The configuration for manifest processing rules.
	//
	// Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
	ManifestProcessingRules interface{} `field:"optional" json:"manifestProcessingRules" yaml:"manifestProcessingRules"`
	// 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 MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html) .
	PersonalizationThresholdSeconds *float64 `field:"optional" json:"personalizationThresholdSeconds" yaml:"personalizationThresholdSeconds"`
	// The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
	//
	// MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
	SlateAdUrl *string `field:"optional" json:"slateAdUrl" yaml:"slateAdUrl"`
	// The tags to assign to the playback configuration.
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
	// 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.
	TranscodeProfileName *string `field:"optional" json:"transcodeProfileName" yaml:"transcodeProfileName"`
}

Properties for defining a `CfnPlaybackConfiguration`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var configurationAliases interface{}

cfnPlaybackConfigurationProps := &cfnPlaybackConfigurationProps{
	adDecisionServerUrl: jsii.String("adDecisionServerUrl"),
	name: jsii.String("name"),
	videoContentSourceUrl: jsii.String("videoContentSourceUrl"),

	// the properties below are optional
	availSuppression: &availSuppressionProperty{
		mode: jsii.String("mode"),
		value: jsii.String("value"),
	},
	bumper: &bumperProperty{
		endUrl: jsii.String("endUrl"),
		startUrl: jsii.String("startUrl"),
	},
	cdnConfiguration: &cdnConfigurationProperty{
		adSegmentUrlPrefix: jsii.String("adSegmentUrlPrefix"),
		contentSegmentUrlPrefix: jsii.String("contentSegmentUrlPrefix"),
	},
	configurationAliases: map[string]interface{}{
		"configurationAliasesKey": configurationAliases,
	},
	dashConfiguration: &dashConfigurationProperty{
		manifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
		mpdLocation: jsii.String("mpdLocation"),
		originManifestType: jsii.String("originManifestType"),
	},
	livePreRollConfiguration: &livePreRollConfigurationProperty{
		adDecisionServerUrl: jsii.String("adDecisionServerUrl"),
		maxDurationSeconds: jsii.Number(123),
	},
	manifestProcessingRules: &manifestProcessingRulesProperty{
		adMarkerPassthrough: &adMarkerPassthroughProperty{
			enabled: jsii.Boolean(false),
		},
	},
	personalizationThresholdSeconds: jsii.Number(123),
	slateAdUrl: jsii.String("slateAdUrl"),
	tags: []cfnTag{
		&cfnTag{
			key: jsii.String("key"),
			value: jsii.String("value"),
		},
	},
	transcodeProfileName: jsii.String("transcodeProfileName"),
}

type CfnPlaybackConfiguration_AdMarkerPassthroughProperty 

type CfnPlaybackConfiguration_AdMarkerPassthroughProperty struct {
	// Enables ad marker passthrough for your configuration.
	Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
}

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` .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

adMarkerPassthroughProperty := &adMarkerPassthroughProperty{
	enabled: jsii.Boolean(false),
}

type CfnPlaybackConfiguration_AvailSuppressionProperty 

type CfnPlaybackConfiguration_AvailSuppressionProperty struct {
	// 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.
	Mode *string `field:"optional" json:"mode" yaml:"mode"`
	// 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.
	Value *string `field:"optional" json:"value" yaml:"value"`
}

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) .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

availSuppressionProperty := &availSuppressionProperty{
	mode: jsii.String("mode"),
	value: jsii.String("value"),
}

type CfnPlaybackConfiguration_BumperProperty 

type CfnPlaybackConfiguration_BumperProperty struct {
	// The URL for the end bumper asset.
	EndUrl *string `field:"optional" json:"endUrl" yaml:"endUrl"`
	// The URL for the start bumper asset.
	StartUrl *string `field:"optional" json:"startUrl" yaml:"startUrl"`
}

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) .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

bumperProperty := &bumperProperty{
	endUrl: jsii.String("endUrl"),
	startUrl: jsii.String("startUrl"),
}

type CfnPlaybackConfiguration_CdnConfigurationProperty 

type CfnPlaybackConfiguration_CdnConfigurationProperty struct {
	// A non-default content delivery network (CDN) to serve ad segments.
	//
	// By default, 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.&lt;region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
	AdSegmentUrlPrefix *string `field:"optional" json:"adSegmentUrlPrefix" yaml:"adSegmentUrlPrefix"`
	// 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 MediaTailor serves a manifest, it reports your CDN as the source for content segments.
	ContentSegmentUrlPrefix *string `field:"optional" json:"contentSegmentUrlPrefix" yaml:"contentSegmentUrlPrefix"`
}

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cdnConfigurationProperty := &cdnConfigurationProperty{
	adSegmentUrlPrefix: jsii.String("adSegmentUrlPrefix"),
	contentSegmentUrlPrefix: jsii.String("contentSegmentUrlPrefix"),
}

type CfnPlaybackConfiguration_DashConfigurationProperty 

type CfnPlaybackConfiguration_DashConfigurationProperty struct {
	// The URL generated by MediaTailor to initiate a playback session.
	//
	// The session uses server-side reporting. This setting is ignored in PUT operations.
	ManifestEndpointPrefix *string `field:"optional" json:"manifestEndpointPrefix" yaml:"manifestEndpointPrefix"`
	// 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.
	MpdLocation *string `field:"optional" json:"mpdLocation" yaml:"mpdLocation"`
	// 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.
	OriginManifestType *string `field:"optional" json:"originManifestType" yaml:"originManifestType"`
}

The configuration for DASH content.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

dashConfigurationProperty := &dashConfigurationProperty{
	manifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
	mpdLocation: jsii.String("mpdLocation"),
	originManifestType: jsii.String("originManifestType"),
}

type CfnPlaybackConfiguration_HlsConfigurationProperty 

type CfnPlaybackConfiguration_HlsConfigurationProperty struct {
	// The URL that is used to initiate a playback session for devices that support Apple HLS.
	//
	// The session uses server-side reporting.
	ManifestEndpointPrefix *string `field:"optional" json:"manifestEndpointPrefix" yaml:"manifestEndpointPrefix"`
}

The configuration for HLS content.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

hlsConfigurationProperty := &hlsConfigurationProperty{
	manifestEndpointPrefix: jsii.String("manifestEndpointPrefix"),
}

type CfnPlaybackConfiguration_LivePreRollConfigurationProperty 

type CfnPlaybackConfiguration_LivePreRollConfigurationProperty struct {
	// The URL for the ad decision server (ADS) for pre-roll ads.
	//
	// This includes the specification of static parameters and placeholders for dynamic parameters. 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.
	AdDecisionServerUrl *string `field:"optional" json:"adDecisionServerUrl" yaml:"adDecisionServerUrl"`
	// The maximum allowed duration for the pre-roll ad avail.
	//
	// MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
	MaxDurationSeconds *float64 `field:"optional" json:"maxDurationSeconds" yaml:"maxDurationSeconds"`
}

The configuration for pre-roll ad insertion.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

livePreRollConfigurationProperty := &livePreRollConfigurationProperty{
	adDecisionServerUrl: jsii.String("adDecisionServerUrl"),
	maxDurationSeconds: jsii.Number(123),
}

type CfnPlaybackConfiguration_ManifestProcessingRulesProperty 

type CfnPlaybackConfiguration_ManifestProcessingRulesProperty struct {
	// 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` .
	AdMarkerPassthrough interface{} `field:"optional" json:"adMarkerPassthrough" yaml:"adMarkerPassthrough"`
}

The configuration for manifest processing rules.

Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

manifestProcessingRulesProperty := &manifestProcessingRulesProperty{
	adMarkerPassthrough: &adMarkerPassthroughProperty{
		enabled: jsii.Boolean(false),
	},
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.