@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
197 lines (196 loc) • 13.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource schema for AWS::MediaTailor::PlaybackConfiguration
*/
export declare class PlaybackConfiguration extends pulumi.CustomResource {
/**
* Get an existing PlaybackConfiguration resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): PlaybackConfiguration;
/**
* Returns true if the given object is an instance of PlaybackConfiguration. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is PlaybackConfiguration;
/**
* 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.
*/
readonly adConditioningConfiguration: pulumi.Output<outputs.mediatailor.PlaybackConfigurationAdConditioningConfiguration | undefined>;
/**
* The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
*/
readonly adDecisionServerUrl: pulumi.Output<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).
*/
readonly availSuppression: pulumi.Output<outputs.mediatailor.PlaybackConfigurationAvailSuppression | undefined>;
/**
* 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).
*/
readonly bumper: pulumi.Output<outputs.mediatailor.PlaybackConfigurationBumper | undefined>;
/**
* The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
*/
readonly cdnConfiguration: pulumi.Output<outputs.mediatailor.PlaybackConfigurationCdnConfiguration | undefined>;
/**
* The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
*/
readonly configurationAliases: pulumi.Output<{
[key: string]: any;
} | undefined>;
/**
* The configuration for DASH content.
*/
readonly dashConfiguration: pulumi.Output<outputs.mediatailor.PlaybackConfigurationDashConfiguration | undefined>;
/**
* The configuration for HLS content.
*/
readonly hlsConfiguration: pulumi.Output<outputs.mediatailor.PlaybackConfigurationHlsConfiguration | undefined>;
/**
* The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
*/
readonly insertionMode: pulumi.Output<enums.mediatailor.PlaybackConfigurationInsertionMode | undefined>;
/**
* The configuration for pre-roll ad insertion.
*/
readonly livePreRollConfiguration: pulumi.Output<outputs.mediatailor.PlaybackConfigurationLivePreRollConfiguration | undefined>;
/**
* The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.
*/
readonly logConfiguration: pulumi.Output<outputs.mediatailor.PlaybackConfigurationLogConfiguration | undefined>;
/**
* The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
*/
readonly manifestProcessingRules: pulumi.Output<outputs.mediatailor.PlaybackConfigurationManifestProcessingRules | undefined>;
/**
* The identifier for the playback configuration.
*/
readonly name: pulumi.Output<string>;
/**
* Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
*/
readonly personalizationThresholdSeconds: pulumi.Output<number | undefined>;
/**
* The Amazon Resource Name (ARN) for the playback configuration.
*/
readonly playbackConfigurationArn: pulumi.Output<string>;
/**
* The URL that the player accesses to get a manifest from MediaTailor. This session will use server-side reporting.
*/
readonly playbackEndpointPrefix: pulumi.Output<string>;
/**
* The URL that the player uses to initialize a session that uses client-side reporting.
*/
readonly sessionInitializationEndpointPrefix: pulumi.Output<string>;
/**
* The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID 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.
*/
readonly slateAdUrl: pulumi.Output<string | undefined>;
/**
* The tags to assign to the playback configuration.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* 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.
*/
readonly transcodeProfileName: pulumi.Output<string | undefined>;
/**
* The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
*/
readonly videoContentSourceUrl: pulumi.Output<string>;
/**
* Create a PlaybackConfiguration resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: PlaybackConfigurationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PlaybackConfiguration resource.
*/
export interface PlaybackConfigurationArgs {
/**
* 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.
*/
adConditioningConfiguration?: pulumi.Input<inputs.mediatailor.PlaybackConfigurationAdConditioningConfigurationArgs>;
/**
* The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
*/
adDecisionServerUrl: pulumi.Input<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?: pulumi.Input<inputs.mediatailor.PlaybackConfigurationAvailSuppressionArgs>;
/**
* 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?: pulumi.Input<inputs.mediatailor.PlaybackConfigurationBumperArgs>;
/**
* The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
*/
cdnConfiguration?: pulumi.Input<inputs.mediatailor.PlaybackConfigurationCdnConfigurationArgs>;
/**
* The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
*/
configurationAliases?: pulumi.Input<{
[key: string]: any;
}>;
/**
* The configuration for DASH content.
*/
dashConfiguration?: pulumi.Input<inputs.mediatailor.PlaybackConfigurationDashConfigurationArgs>;
/**
* The configuration for HLS content.
*/
hlsConfiguration?: pulumi.Input<inputs.mediatailor.PlaybackConfigurationHlsConfigurationArgs>;
/**
* The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.
*/
insertionMode?: pulumi.Input<enums.mediatailor.PlaybackConfigurationInsertionMode>;
/**
* The configuration for pre-roll ad insertion.
*/
livePreRollConfiguration?: pulumi.Input<inputs.mediatailor.PlaybackConfigurationLivePreRollConfigurationArgs>;
/**
* The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.
*/
logConfiguration?: pulumi.Input<inputs.mediatailor.PlaybackConfigurationLogConfigurationArgs>;
/**
* The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
*/
manifestProcessingRules?: pulumi.Input<inputs.mediatailor.PlaybackConfigurationManifestProcessingRulesArgs>;
/**
* The identifier for the playback configuration.
*/
name?: pulumi.Input<string>;
/**
* Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor (https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).
*/
personalizationThresholdSeconds?: pulumi.Input<number>;
/**
* The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID 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?: pulumi.Input<string>;
/**
* The tags to assign to the playback configuration.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* 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?: pulumi.Input<string>;
/**
* The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
*/
videoContentSourceUrl: pulumi.Input<string>;
}