ALIYUN::DEVOPS::PipelineRun is used to run a pipeline.
Syntax
{
"Type": "ALIYUN::DEVOPS::PipelineRun",
"Properties": {
"PipelineId": Number,
"Params": Map,
"OrganizationId": String,
"Sync": Boolean,
"Timeout": Integer
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
PipelineId | Number | Yes | No | The pipeline ID. | You can obtain the pipeline ID from the pipeline URL. Sample URL: |
Params | Map | No | No | The parameters that are used to run the pipeline. | Valid values:
Example:
|
OrganizationId | String | Yes | No | The ID of the organization workspace. | The value is of the String type. You can obtain the ID of the organization workspace from the URL of Apsara Devops. Sample URL: |
Sync | Boolean | No | No | Specifies whether to synchronously wait for the running result of the pipeline. | Valid values:
Note If the pipeline is configured with a suspension policy, we recommend that you do not set the value to true. This is because the release process requires manual operations and is not suitable for synchronization. |
Timeout | Integer | No | No | The maximum timeout period for running the pipeline. | Unit: minutes. You must specify this property when Sync is set to true. Default value: 10. |
Return values
Fn::GetAtt
PipelineRunId: the ID of the instance that runs the pipeline.