ALIYUN::MPS::TranscodeJob - Resource Orchestration Service

The ALIYUN::MPS::TranscodeJob resource is used to submit a transcoding job.

Syntax

{
  "Type": "ALIYUN::MPS::TranscodeJob",
  "Properties": {
    "Input": Map,
    "OutputBucket": String,
    "Outputs": List,
    "PipelineId": String,
    "OutputLocation": String
  }
}

Properties

Property name	Type	Required	Update allowed	Description	Constraints
Input	Map	Yes	No	The job input.	For more information, see Parameter details. The region of the Object Storage Service (OSS) bucket must be the same as the current ApsaraVideo Media Processing (MPS) region. Note In the ApsaraVideo Media Processing API, the Object parameter must be URL-encoded based on UTF-8 before use. Example: `{"Bucket":"exampleBucket","Location":"oss-cn-hangzhou","Object":"example.flv","Referer": "The hotlink protection parameters configured in the OSS console"}`
OutputBucket	String	Yes	No	The OSS bucket where the output file is stored.	This property must conform to OSS bucket naming rules. For more information, see Terms.
Outputs	List	Yes	No	The job output configurations.	For more information, see Parameter details. A list of Output objects in a JSON array. The maximum number of objects is 30. Example: `[{"OutputObject":"exampleOutput.mp4","TemplateId":"6181666213ab41b9bc21da8ff5ff**","WaterMarks":[{"InputFile":{"Bucket":"exampleBucket","Location":"oss-cn-hangzhou","Object":"image_01.png"},"WaterMarkTemplateId":"9b772ce2740d4d55876d8b542d47**"}],"UserData":"testid-001"}]`
PipelineId	String	Yes	No	The pipeline ID.	For more information, see Terms.
OutputLocation	String	No	No	The region of the OSS bucket where the output file is stored.	The OSS bucket must be in the same region as the ApsaraVideo Media Processing service. The bucket must comply with the OSS Bucket definition. For more information, see Terms.

Return values

Fn::GetAtt

JobIds: A list of job IDs.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  OutputBucket:
    Type: String
    Description:
      en: The name of the OSS bucket where the output files are stored.
    Required: true
  Input:
    Type: Json
    Description:
      en: The input configuration of the job. For more information, see Input details.
    Required: true
  Outputs:
    AssociationPropertyMetadata: {}
    AssociationProperty: List[Parameters]
    Type: Json
    Description:
      en: The output configuration of the job. Consists of a list of Output objects, JSON array, with a maximum size of 30.
    Required: true
  PipelineId:
    Type: String
    Description:
      en: The ID of the pipeline.
    Required: true
Resources:
  TranscodeJob:
    Type: ALIYUN::MPS::TranscodeJob
    Properties:
      OutputBucket:
        Ref: OutputBucket
      Input:
        Ref: Input
      Outputs:
        Ref: Outputs
      PipelineId:
        Ref: PipelineId
Outputs:
  JobIds:
    Description: The IDs of the jobs.
    Value:
      Fn::GetAtt:
        - TranscodeJob
        - JobIds

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "OutputBucket": {
      "Type": "String",
      "Description": {
        "en": "The name of the OSS bucket where the output files are stored."
      },
      "Required": true
    },
    "Input": {
      "Type": "Json",
      "Description": {
        "en": "The input configuration of the job. For more information, see Input details."
      },
      "Required": true
    },
    "Outputs": {
      "AssociationPropertyMetadata": {},
      "AssociationProperty": "List[Parameters]",
      "Type": "Json",
      "Description": {
        "en": "The output configuration of the job. Consists of a list of Output objects, JSON array, with a maximum size of 30."
      },
      "Required": true
    },
    "PipelineId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the pipeline."
      },
      "Required": true
    }
  },
  "Resources": {
    "TranscodeJob": {
      "Type": "ALIYUN::MPS::TranscodeJob",
      "Properties": {
        "OutputBucket": {
          "Ref": "OutputBucket"
        },
        "Input": {
          "Ref": "Input"
        },
        "Outputs": {
          "Ref": "Outputs"
        },
        "PipelineId": {
          "Ref": "PipelineId"
        }
      }
    }
  },
  "Outputs": {
    "JobIds": {
      "Description": "The IDs of the jobs.",
      "Value": {
        "Fn::GetAtt": [
          "TranscodeJob",
          "JobIds"
        ]
      }
    }
  }
}