Skip to content

PipelineRunProps

Properties for defining a PipelineRun.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-devops-pipelinerun

Initializer 

import { PipelineRunProps } from '@alicloud/ros-cdk-devops'
const pipelineRunProps: PipelineRunProps = { ... }

Properties

Name Type Description
organizationId string | @alicloud/ros-cdk-core.IResolvable Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links.
pipelineId number | @alicloud/ros-cdk-core.IResolvable Property pipelineId: The pipeline ID, which can be obtained from the pipeline link.
params @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property params: Pipeline operating parameters.
sync boolean | @alicloud/ros-cdk-core.IResolvable Property sync: Whether to wait synchronously for the result of the pipeline execution.
timeout number | @alicloud/ros-cdk-core.IResolvable Property timeout: Maximum wait time for pipeline execution in minutes.

organizationIdRequired 

public readonly organizationId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links.

pipelineIdRequired 

public readonly pipelineId: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property pipelineId: The pipeline ID, which can be obtained from the pipeline link.

paramsOptional 

public readonly params: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property params: Pipeline operating parameters.

Keys: - branchModeBranchs: Branch mode runs branches. - envs: Running variables. - runningBranchs: Running branches whose key is the warehouse address. - runningTags: Running tags whose key is the warehouse address.

syncOptional 

public readonly sync: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property sync: Whether to wait synchronously for the result of the pipeline execution.

If you select true, the resource will not be created until the pipeline is complete. Default is false. Note: Do not set this option to true when the pipeline has a pause policy configured, as publishing requires manual intervention and synchronization is not appropriate.

timeoutOptional 

public readonly timeout: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property timeout: Maximum wait time for pipeline execution in minutes.

This parameter need only be configured if Sync is set to true. Default is 10.