@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Transcoding Job Resource * * To get more information about Job, see: * * * [API documentation](https://cloud.google.com/transcoder/docs/reference/rest/v1/projects.locations.jobs) * * How-to Guides * * [Transcoder](https://cloud.google.com/transcoder/docs/) * * ## Example Usage * * ### Transcoder Job Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.storage.Bucket("default", { * name: "transcoder-job", * location: "US", * forceDestroy: true, * uniformBucketLevelAccess: true, * publicAccessPrevention: "enforced", * }); * const exampleMp4 = new gcp.storage.BucketObject("example_mp4", { * name: "example.mp4", * source: new pulumi.asset.FileAsset("./test-fixtures/example.mp4"), * bucket: _default.name, * }); * const defaultJobTemplate = new gcp.transcoder.JobTemplate("default", { * jobTemplateId: "example-job-template", * location: "us-central1", * config: { * inputs: [{ * key: "input0", * uri: pulumi.interpolate`gs://${_default.name}/${exampleMp4.name}`, * }], * output: { * uri: pulumi.interpolate`gs://${_default.name}/outputs/`, * }, * editLists: [{ * key: "atom0", * inputs: ["input0"], * startTimeOffset: "0s", * }], * elementaryStreams: [ * { * key: "video-stream0", * videoStream: { * h264: { * widthPixels: 640, * heightPixels: 360, * bitrateBps: 550000, * frameRate: 60, * pixelFormat: "yuv420p", * rateControlMode: "vbr", * crfLevel: 21, * gopDuration: "3s", * vbvSizeBits: 550000, * vbvFullnessBits: 495000, * entropyCoder: "cabac", * profile: "high", * preset: "veryfast", * }, * }, * }, * { * key: "video-stream1", * videoStream: { * h264: { * widthPixels: 1280, * heightPixels: 720, * bitrateBps: 550000, * frameRate: 60, * pixelFormat: "yuv420p", * rateControlMode: "vbr", * crfLevel: 21, * gopDuration: "3s", * vbvSizeBits: 2500000, * vbvFullnessBits: 2250000, * entropyCoder: "cabac", * profile: "high", * preset: "veryfast", * }, * }, * }, * { * key: "audio-stream0", * audioStream: { * codec: "aac", * bitrateBps: 64000, * channelCount: 2, * channelLayouts: [ * "fl", * "fr", * ], * sampleRateHertz: 48000, * }, * }, * ], * muxStreams: [ * { * key: "sd", * fileName: "sd.mp4", * container: "mp4", * elementaryStreams: [ * "video-stream0", * "audio-stream0", * ], * }, * { * key: "hd", * fileName: "hd.mp4", * container: "mp4", * elementaryStreams: [ * "video-stream1", * "audio-stream0", * ], * }, * ], * }, * labels: { * label: "key", * }, * }); * const defaultJob = new gcp.transcoder.Job("default", { * templateId: defaultJobTemplate.name, * location: "us-central1", * labels: { * label: "key", * }, * }); * ``` * ### Transcoder Job Pubsub * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.storage.Bucket("default", { * name: "transcoder-job", * location: "US", * forceDestroy: true, * uniformBucketLevelAccess: true, * publicAccessPrevention: "enforced", * }); * const exampleMp4 = new gcp.storage.BucketObject("example_mp4", { * name: "example.mp4", * source: new pulumi.asset.FileAsset("./test-fixtures/example.mp4"), * bucket: _default.name, * }); * const transcoderNotifications = new gcp.pubsub.Topic("transcoder_notifications", {name: "transcoder-notifications"}); * const defaultJob = new gcp.transcoder.Job("default", { * location: "us-central1", * config: { * inputs: [{ * key: "input0", * uri: pulumi.interpolate`gs://${_default.name}/${exampleMp4.name}`, * }], * editLists: [{ * key: "atom0", * inputs: ["input0"], * startTimeOffset: "0s", * }], * adBreaks: [{ * startTimeOffset: "3.500s", * }], * elementaryStreams: [ * { * key: "video-stream0", * videoStream: { * h264: { * widthPixels: 640, * heightPixels: 360, * bitrateBps: 550000, * frameRate: 60, * pixelFormat: "yuv420p", * rateControlMode: "vbr", * crfLevel: 21, * gopDuration: "3s", * vbvSizeBits: 550000, * vbvFullnessBits: 495000, * entropyCoder: "cabac", * profile: "high", * preset: "veryfast", * }, * }, * }, * { * key: "video-stream1", * videoStream: { * h264: { * widthPixels: 1280, * heightPixels: 720, * bitrateBps: 550000, * frameRate: 60, * pixelFormat: "yuv420p", * rateControlMode: "vbr", * crfLevel: 21, * gopDuration: "3s", * vbvSizeBits: 2500000, * vbvFullnessBits: 2250000, * entropyCoder: "cabac", * profile: "high", * preset: "veryfast", * }, * }, * }, * { * key: "audio-stream0", * audioStream: { * codec: "aac", * bitrateBps: 64000, * channelCount: 2, * channelLayouts: [ * "fl", * "fr", * ], * sampleRateHertz: 48000, * }, * }, * ], * muxStreams: [ * { * key: "sd", * fileName: "sd.mp4", * container: "mp4", * elementaryStreams: [ * "video-stream0", * "audio-stream0", * ], * }, * { * key: "hd", * fileName: "hd.mp4", * container: "mp4", * elementaryStreams: [ * "video-stream1", * "audio-stream0", * ], * }, * ], * pubsubDestination: { * topic: transcoderNotifications.id, * }, * output: { * uri: pulumi.interpolate`gs://${_default.name}/outputs/`, * }, * }, * labels: { * label: "key", * }, * }); * ``` * ### Transcoder Job Encryptions * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.storage.Bucket("default", { * name: "transcoder-job", * location: "US", * forceDestroy: true, * uniformBucketLevelAccess: true, * publicAccessPrevention: "enforced", * }); * const exampleMp4 = new gcp.storage.BucketObject("example_mp4", { * name: "example.mp4", * source: new pulumi.asset.FileAsset("./test-fixtures/example.mp4"), * bucket: _default.name, * }); * const encryptionKey = new gcp.secretmanager.Secret("encryption_key", { * secretId: "transcoder-encryption-key", * replication: { * auto: {}, * }, * }); * const encryptionKeySecretVersion = new gcp.secretmanager.SecretVersion("encryption_key", { * secret: encryptionKey.name, * secretData: "4A67F2C1B8E93A4F6D3E7890A1BC23DF", * }); * const project = gcp.organizations.getProject({}); * // this is required to allow the transcoder service identity to access the secret * const transcoder = new gcp.projects.ServiceIdentity("transcoder", { * project: project.then(project => project.projectId), * service: "transcoder.googleapis.com", * }); * const transcoderEncryptionKeyAccessor = new gcp.secretmanager.SecretIamMember("transcoder_encryption_key_accessor", { * secretId: encryptionKey.secretId, * project: encryptionKey.project, * role: "roles/secretmanager.secretAccessor", * member: pulumi.interpolate`serviceAccount:${transcoder.email}`, * }); * const defaultJob = new gcp.transcoder.Job("default", { * location: "us-central1", * config: { * inputs: [{ * key: "input0", * uri: pulumi.interpolate`gs://${_default.name}/${exampleMp4.name}`, * }], * elementaryStreams: [ * { * key: "es_video", * videoStream: { * h264: { * profile: "main", * heightPixels: 600, * widthPixels: 800, * bitrateBps: 1000000, * frameRate: 60, * }, * }, * }, * { * key: "es_audio", * audioStream: { * codec: "aac", * channelCount: 2, * bitrateBps: 160000, * }, * }, * ], * encryptions: [ * { * id: "aes-128", * secretManagerKeySource: { * secretVersion: encryptionKeySecretVersion.name, * }, * drmSystems: { * clearkey: {}, * }, * aes128: {}, * }, * { * id: "cenc", * secretManagerKeySource: { * secretVersion: encryptionKeySecretVersion.name, * }, * drmSystems: { * widevine: {}, * }, * mpegCenc: { * scheme: "cenc", * }, * }, * { * id: "cbcs", * secretManagerKeySource: { * secretVersion: encryptionKeySecretVersion.name, * }, * drmSystems: { * widevine: {}, * }, * mpegCenc: { * scheme: "cbcs", * }, * }, * ], * muxStreams: [ * { * key: "ts_aes128", * container: "ts", * elementaryStreams: [ * "es_video", * "es_audio", * ], * segmentSettings: { * segmentDuration: "6s", * }, * encryptionId: "aes-128", * }, * { * key: "fmp4_cenc_video", * container: "fmp4", * elementaryStreams: ["es_video"], * segmentSettings: { * segmentDuration: "6s", * }, * encryptionId: "cenc", * }, * { * key: "fmp4_cenc_audio", * container: "fmp4", * elementaryStreams: ["es_audio"], * segmentSettings: { * segmentDuration: "6s", * }, * encryptionId: "cenc", * }, * { * key: "fmp4_cbcs_video", * container: "fmp4", * elementaryStreams: ["es_video"], * segmentSettings: { * segmentDuration: "6s", * }, * encryptionId: "cbcs", * }, * { * key: "fmp4_cbcs_audio", * container: "fmp4", * elementaryStreams: ["es_audio"], * segmentSettings: { * segmentDuration: "6s", * }, * encryptionId: "cbcs", * }, * ], * manifests: [ * { * fileName: "manifest_aes128.m3u8", * type: "HLS", * muxStreams: ["ts_aes128"], * }, * { * fileName: "manifest_cenc.mpd", * type: "DASH", * muxStreams: [ * "fmp4_cenc_video", * "fmp4_cenc_audio", * ], * }, * { * fileName: "manifest_cbcs.mpd", * type: "DASH", * muxStreams: [ * "fmp4_cbcs_video", * "fmp4_cbcs_audio", * ], * }, * ], * output: { * uri: pulumi.interpolate`gs://${_default.name}/outputs/`, * }, * }, * labels: { * label: "key", * }, * }); * ``` * ### Transcoder Job Overlays * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.storage.Bucket("default", { * name: "transcoder-job", * location: "US", * forceDestroy: true, * uniformBucketLevelAccess: true, * publicAccessPrevention: "enforced", * }); * const exampleMp4 = new gcp.storage.BucketObject("example_mp4", { * name: "example.mp4", * source: new pulumi.asset.FileAsset("./test-fixtures/example.mp4"), * bucket: _default.name, * }); * const overlayPng = new gcp.storage.BucketObject("overlay_png", { * name: "overlay.png", * source: new pulumi.asset.FileAsset("./test-fixtures/overlay.png"), * bucket: _default.name, * }); * const defaultJob = new gcp.transcoder.Job("default", { * location: "us-central1", * config: { * inputs: [{ * key: "input0", * uri: pulumi.interpolate`gs://${_default.name}/${exampleMp4.name}`, * }], * editLists: [{ * key: "atom0", * inputs: ["input0"], * startTimeOffset: "0s", * }], * adBreaks: [{ * startTimeOffset: "3.500s", * }], * overlays: [{ * animations: [{ * animationFade: { * fadeType: "FADE_IN", * startTimeOffset: "1.500s", * endTimeOffset: "3.500s", * xy: { * x: 1, * y: 0.5, * }, * }, * }], * image: { * uri: pulumi.interpolate`gs://${_default.name}/${overlayPng.name}`, * }, * }], * elementaryStreams: [ * { * key: "video-stream0", * videoStream: { * h264: { * widthPixels: 640, * heightPixels: 360, * bitrateBps: 550000, * frameRate: 60, * pixelFormat: "yuv420p", * rateControlMode: "vbr", * crfLevel: 21, * gopDuration: "3s", * vbvSizeBits: 550000, * vbvFullnessBits: 495000, * entropyCoder: "cabac", * profile: "high", * preset: "veryfast", * }, * }, * }, * { * key: "video-stream1", * videoStream: { * h264: { * widthPixels: 1280, * heightPixels: 720, * bitrateBps: 550000, * frameRate: 60, * pixelFormat: "yuv420p", * rateControlMode: "vbr", * crfLevel: 21, * gopDuration: "3s", * vbvSizeBits: 2500000, * vbvFullnessBits: 2250000, * entropyCoder: "cabac", * profile: "high", * preset: "veryfast", * }, * }, * }, * { * key: "audio-stream0", * audioStream: { * codec: "aac", * bitrateBps: 64000, * channelCount: 2, * channelLayouts: [ * "fl", * "fr", * ], * sampleRateHertz: 48000, * }, * }, * ], * muxStreams: [ * { * key: "sd", * fileName: "sd.mp4", * container: "mp4", * elementaryStreams: [ * "video-stream0", * "audio-stream0", * ], * }, * { * key: "hd", * fileName: "hd.mp4", * container: "mp4", * elementaryStreams: [ * "video-stream1", * "audio-stream0", * ], * }, * ], * output: { * uri: pulumi.interpolate`gs://${_default.name}/outputs/`, * }, * }, * labels: { * label: "key", * }, * }); * ``` * ### Transcoder Job Manifests * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.storage.Bucket("default", { * name: "transcoder-job", * location: "US", * forceDestroy: true, * uniformBucketLevelAccess: true, * publicAccessPrevention: "enforced", * }); * const exampleMp4 = new gcp.storage.BucketObject("example_mp4", { * name: "example.mp4", * source: new pulumi.asset.FileAsset("./test-fixtures/example.mp4"), * bucket: _default.name, * }); * const defaultJob = new gcp.transcoder.Job("default", { * location: "us-central1", * config: { * inputs: [{ * key: "input0", * uri: pulumi.interpolate`gs://${_default.name}/${exampleMp4.name}`, * }], * editLists: [{ * key: "atom0", * startTimeOffset: "0s", * inputs: ["input0"], * }], * adBreaks: [{ * startTimeOffset: "3.500s", * }], * elementaryStreams: [ * { * key: "video-stream0", * videoStream: { * h264: { * widthPixels: 640, * heightPixels: 360, * bitrateBps: 550000, * frameRate: 60, * pixelFormat: "yuv420p", * rateControlMode: "vbr", * crfLevel: 21, * gopDuration: "3s", * vbvSizeBits: 550000, * vbvFullnessBits: 495000, * entropyCoder: "cabac", * profile: "high", * preset: "veryfast", * }, * }, * }, * { * key: "video-stream1", * videoStream: { * h264: { * widthPixels: 1280, * heightPixels: 720, * bitrateBps: 550000, * frameRate: 60, * pixelFormat: "yuv420p", * rateControlMode: "vbr", * crfLevel: 21, * gopDuration: "3s", * vbvSizeBits: 2500000, * vbvFullnessBits: 2250000, * entropyCoder: "cabac", * profile: "high", * preset: "veryfast", * }, * }, * }, * { * key: "audio-stream0", * audioStream: { * codec: "aac", * bitrateBps: 64000, * channelCount: 2, * channelLayouts: [ * "fl", * "fr", * ], * sampleRateHertz: 48000, * }, * }, * ], * muxStreams: [ * { * key: "sd", * fileName: "sd.mp4", * container: "mp4", * elementaryStreams: [ * "video-stream0", * "audio-stream0", * ], * }, * { * key: "hd", * fileName: "hd.mp4", * container: "mp4", * elementaryStreams: [ * "video-stream1", * "audio-stream0", * ], * }, * { * key: "media-sd", * fileName: "media-sd.ts", * container: "ts", * elementaryStreams: [ * "video-stream0", * "audio-stream0", * ], * }, * { * key: "media-hd", * fileName: "media-hd.ts", * container: "ts", * elementaryStreams: [ * "video-stream1", * "audio-stream0", * ], * }, * { * key: "video-only-sd", * fileName: "video-only-sd.m4s", * container: "fmp4", * elementaryStreams: ["video-stream0"], * }, * { * key: "video-only-hd", * fileName: "video-only-hd.m4s", * container: "fmp4", * elementaryStreams: ["video-stream1"], * }, * { * key: "audio-only", * fileName: "audio-only.m4s", * container: "fmp4", * elementaryStreams: ["audio-stream0"], * }, * ], * manifests: [ * { * fileName: "manifest.m3u8", * type: "HLS", * muxStreams: [ * "media-sd", * "media-hd", * ], * }, * { * fileName: "manifest.mpd", * type: "DASH", * muxStreams: [ * "video-only-sd", * "video-only-hd", * "audio-only", * ], * }, * ], * output: { * uri: pulumi.interpolate`gs://${_default.name}/outputs/`, * }, * }, * labels: { * label: "key", * }, * }); * ``` * * ## Import * * Job can be imported using any of these accepted formats: * * * `{{project}}/{{name}}` * * `{{project}} {{name}}` * * `{{name}}` * * When using the `pulumi import` command, Job can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:transcoder/job:Job default {{project}}/{{name}} * $ terraform import google_transcoder_job.default "{{project}} {{name}}" * $ pulumi import gcp:transcoder/job:Job default {{name}} * ``` */ export declare class Job extends pulumi.CustomResource { /** * Get an existing Job 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: JobState, opts?: pulumi.CustomResourceOptions): Job; /** * Returns true if the given object is an instance of Job. 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 Job; /** * The configuration for this template. * Structure is documented below. */ readonly config: pulumi.Output<outputs.transcoder.JobConfig>; /** * The time the job was created. */ readonly createTime: pulumi.Output<string>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ readonly deletionPolicy: pulumi.Output<string>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * The time the transcoding finished. */ readonly endTime: pulumi.Output<string>; /** * The labels associated with this job. You can use these to organize and group your jobs. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The location of the transcoding job resource. */ readonly location: pulumi.Output<string>; /** * The resource name of the job. */ readonly name: pulumi.Output<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output<string>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * The time the transcoding started. */ readonly startTime: pulumi.Output<string>; /** * The current state of the job. */ readonly state: pulumi.Output<string>; /** * Specify the templateId to use for populating Job.config. * The default is preset/web-hd, which is the only supported preset. */ readonly templateId: pulumi.Output<string>; /** * Create a Job 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: JobArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Job resources. */ export interface JobState { /** * The configuration for this template. * Structure is documented below. */ config?: pulumi.Input<inputs.transcoder.JobConfig | undefined>; /** * The time the job was created. */ createTime?: pulumi.Input<string | undefined>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The time the transcoding finished. */ endTime?: pulumi.Input<string | undefined>; /** * The labels associated with this job. You can use these to organize and group your jobs. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The location of the transcoding job resource. */ location?: pulumi.Input<string | undefined>; /** * The resource name of the job. */ name?: pulumi.Input<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The time the transcoding started. */ startTime?: pulumi.Input<string | undefined>; /** * The current state of the job. */ state?: pulumi.Input<string | undefined>; /** * Specify the templateId to use for populating Job.config. * The default is preset/web-hd, which is the only supported preset. */ templateId?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a Job resource. */ export interface JobArgs { /** * The configuration for this template. * Structure is documented below. */ config?: pulumi.Input<inputs.transcoder.JobConfig | undefined>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * The labels associated with this job. You can use these to organize and group your jobs. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The location of the transcoding job resource. */ location: pulumi.Input<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * Specify the templateId to use for populating Job.config. * The default is preset/web-hd, which is the only supported preset. */ templateId?: pulumi.Input<string | undefined>; } //# sourceMappingURL=job.d.ts.map