1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. elastictranscoder

Module elastictranscoder

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource Pipeline

class Pipeline extends CustomResource

Provides an Elastic Transcoder pipeline resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const bar = new aws.elastictranscoder.Pipeline("bar", {
    contentConfig: {
        bucket: aws_s3_bucket_content_bucket.bucket,
        storageClass: "Standard",
    },
    inputBucket: aws_s3_bucket_input_bucket.bucket,
    role: aws_iam_role_test_role.arn,
    thumbnailConfig: {
        bucket: aws_s3_bucket_thumb_bucket.bucket,
        storageClass: "Standard",
    },
});

constructor

new Pipeline(name: string, args: PipelineArgs, opts?: pulumi.CustomResourceOptions)

Create a Pipeline resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PipelineState, opts?: pulumi.CustomResourceOptions): Pipeline

Get an existing Pipeline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Pipeline

Returns true if the given object is an instance of Pipeline. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

property awsKmsKeyArn

public awsKmsKeyArn: pulumi.Output<string | undefined>;

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

property contentConfig

public contentConfig: pulumi.Output<PipelineContentConfig>;

The ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. (documented below)

property contentConfigPermissions

public contentConfigPermissions: pulumi.Output<PipelineContentConfigPermission[] | undefined>;

The permissions for the contentConfig object. (documented below)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inputBucket

public inputBucket: pulumi.Output<string>;

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.

property name

public name: pulumi.Output<string>;

The name of the pipeline. Maximum 40 characters

property notifications

public notifications: pulumi.Output<PipelineNotifications | undefined>;

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. (documented below)

property outputBucket

public outputBucket: pulumi.Output<string>;

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

property role

public role: pulumi.Output<string>;

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.

property thumbnailConfig

public thumbnailConfig: pulumi.Output<PipelineThumbnailConfig>;

The ThumbnailConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. (documented below)

property thumbnailConfigPermissions

public thumbnailConfigPermissions: pulumi.Output<PipelineThumbnailConfigPermission[] | undefined>;

The permissions for the thumbnailConfig object. (documented below)

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Preset

class Preset extends CustomResource

Provides an Elastic Transcoder preset resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const bar = new aws.elastictranscoder.Preset("bar", {
    audio: {
        audioPackingMode: "SingleTrack",
        bitRate: "96",
        channels: "2",
        codec: "AAC",
        sampleRate: "44100",
    },
    audioCodecOptions: {
        profile: "AAC-LC",
    },
    container: "mp4",
    description: "Sample Preset",
    thumbnails: {
        format: "png",
        interval: "120",
        maxHeight: "auto",
        maxWidth: "auto",
        paddingPolicy: "Pad",
        sizingPolicy: "Fit",
    },
    video: {
        bitRate: "1600",
        codec: "H.264",
        displayAspectRatio: "16:9",
        fixedGop: "false",
        frameRate: "auto",
        keyframesMaxDist: "240",
        maxFrameRate: "60",
        maxHeight: "auto",
        maxWidth: "auto",
        paddingPolicy: "Pad",
        sizingPolicy: "Fit",
    },
    videoCodecOptions: {
        ColorSpaceConversionMode: "None",
        InterlacedMode: "Progressive",
        Level: "2.2",
        MaxReferenceFrames: 3,
        Profile: "main",
    },
    videoWatermarks: [{
        horizontalAlign: "Right",
        horizontalOffset: "10px",
        id: "Test",
        maxHeight: "20%",
        maxWidth: "20%",
        opacity: "55.5",
        sizingPolicy: "ShrinkToFit",
        target: "Content",
        verticalAlign: "Bottom",
        verticalOffset: "10px",
    }],
});

constructor

new Preset(name: string, args: PresetArgs, opts?: pulumi.CustomResourceOptions)

Create a Preset resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PresetState, opts?: pulumi.CustomResourceOptions): Preset

Get an existing Preset resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Preset

Returns true if the given object is an instance of Preset. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

property audio

public audio: pulumi.Output<PresetAudio | undefined>;

Audio parameters object (documented below).

property audioCodecOptions

public audioCodecOptions: pulumi.Output<PresetAudioCodecOptions | undefined>;

Codec options for the audio parameters (documented below)

property container

public container: pulumi.Output<string>;

The container type for the output file. Valid values are flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

property description

public description: pulumi.Output<string | undefined>;

A description of the preset (maximum 255 characters)

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the preset. (maximum 40 characters)

property thumbnails

public thumbnails: pulumi.Output<PresetThumbnails | undefined>;

Thumbnail parameters object (documented below)

property type

public type: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property video

public video: pulumi.Output<PresetVideo | undefined>;

Video parameters object (documented below)

property videoCodecOptions

public videoCodecOptions: pulumi.Output<{[key: string]: any} | undefined>;

Codec options for the video parameters

property videoWatermarks

public videoWatermarks: pulumi.Output<PresetVideoWatermark[] | undefined>;

Watermark parameters for the video parameters (documented below)

Others

interface PipelineArgs

interface PipelineArgs

The set of arguments for constructing a Pipeline resource.

property awsKmsKeyArn

awsKmsKeyArn?: pulumi.Input<string>;

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

property contentConfig

contentConfig?: pulumi.Input<PipelineContentConfig>;

The ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. (documented below)

property contentConfigPermissions

contentConfigPermissions?: pulumi.Input<pulumi.Input<PipelineContentConfigPermission>[]>;

The permissions for the contentConfig object. (documented below)

property inputBucket

inputBucket: pulumi.Input<string>;

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.

property name

name?: pulumi.Input<string>;

The name of the pipeline. Maximum 40 characters

property notifications

notifications?: pulumi.Input<PipelineNotifications>;

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. (documented below)

property outputBucket

outputBucket?: pulumi.Input<string>;

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

property role

role: pulumi.Input<string>;

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.

property thumbnailConfig

thumbnailConfig?: pulumi.Input<PipelineThumbnailConfig>;

The ThumbnailConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. (documented below)

property thumbnailConfigPermissions

thumbnailConfigPermissions?: pulumi.Input<pulumi.Input<PipelineThumbnailConfigPermission>[]>;

The permissions for the thumbnailConfig object. (documented below)

interface PipelineState

interface PipelineState

Input properties used for looking up and filtering Pipeline resources.

property arn

arn?: pulumi.Input<string>;

property awsKmsKeyArn

awsKmsKeyArn?: pulumi.Input<string>;

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

property contentConfig

contentConfig?: pulumi.Input<PipelineContentConfig>;

The ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. (documented below)

property contentConfigPermissions

contentConfigPermissions?: pulumi.Input<pulumi.Input<PipelineContentConfigPermission>[]>;

The permissions for the contentConfig object. (documented below)

property inputBucket

inputBucket?: pulumi.Input<string>;

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.

property name

name?: pulumi.Input<string>;

The name of the pipeline. Maximum 40 characters

property notifications

notifications?: pulumi.Input<PipelineNotifications>;

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. (documented below)

property outputBucket

outputBucket?: pulumi.Input<string>;

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

property role

role?: pulumi.Input<string>;

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.

property thumbnailConfig

thumbnailConfig?: pulumi.Input<PipelineThumbnailConfig>;

The ThumbnailConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. (documented below)

property thumbnailConfigPermissions

thumbnailConfigPermissions?: pulumi.Input<pulumi.Input<PipelineThumbnailConfigPermission>[]>;

The permissions for the thumbnailConfig object. (documented below)

interface PresetArgs

interface PresetArgs

The set of arguments for constructing a Preset resource.

property audio

audio?: pulumi.Input<PresetAudio>;

Audio parameters object (documented below).

property audioCodecOptions

audioCodecOptions?: pulumi.Input<PresetAudioCodecOptions>;

Codec options for the audio parameters (documented below)

property container

container: pulumi.Input<string>;

The container type for the output file. Valid values are flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

property description

description?: pulumi.Input<string>;

A description of the preset (maximum 255 characters)

property name

name?: pulumi.Input<string>;

The name of the preset. (maximum 40 characters)

property thumbnails

thumbnails?: pulumi.Input<PresetThumbnails>;

Thumbnail parameters object (documented below)

property type

type?: pulumi.Input<string>;

property video

video?: pulumi.Input<PresetVideo>;

Video parameters object (documented below)

property videoCodecOptions

videoCodecOptions?: pulumi.Input<{[key: string]: any}>;

Codec options for the video parameters

property videoWatermarks

videoWatermarks?: pulumi.Input<pulumi.Input<PresetVideoWatermark>[]>;

Watermark parameters for the video parameters (documented below)

interface PresetState

interface PresetState

Input properties used for looking up and filtering Preset resources.

property arn

arn?: pulumi.Input<string>;

property audio

audio?: pulumi.Input<PresetAudio>;

Audio parameters object (documented below).

property audioCodecOptions

audioCodecOptions?: pulumi.Input<PresetAudioCodecOptions>;

Codec options for the audio parameters (documented below)

property container

container?: pulumi.Input<string>;

The container type for the output file. Valid values are flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

property description

description?: pulumi.Input<string>;

A description of the preset (maximum 255 characters)

property name

name?: pulumi.Input<string>;

The name of the preset. (maximum 40 characters)

property thumbnails

thumbnails?: pulumi.Input<PresetThumbnails>;

Thumbnail parameters object (documented below)

property type

type?: pulumi.Input<string>;

property video

video?: pulumi.Input<PresetVideo>;

Video parameters object (documented below)

property videoCodecOptions

videoCodecOptions?: pulumi.Input<{[key: string]: any}>;

Codec options for the video parameters

property videoWatermarks

videoWatermarks?: pulumi.Input<pulumi.Input<PresetVideoWatermark>[]>;

Watermark parameters for the video parameters (documented below)