Skip to content

PipelineRunProps

Properties for defining a PipelineRun.

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

Initializer 

import ros_cdk_devops
ros_cdk_devops.PipelineRunProps(
  organization_id: typing.Union[str, IResolvable],
  pipeline_id: typing.Union[typing.Union[int, float], IResolvable],
  params: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  sync: typing.Union[bool, IResolvable] = None,
  timeout: typing.Union[typing.Union[int, float], IResolvable] = None
)

Properties

Name Type Description
organization_id typing.Union[str, ros_cdk_core.IResolvable] Property organizationId: Corporate identity, also known as enterprise id, can obtain in cloud effect access links.
pipeline_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property pipelineId: The pipeline ID, which can be obtained from the pipeline link.
params typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property params: Pipeline operating parameters.
sync typing.Union[bool, ros_cdk_core.IResolvable] Property sync: Whether to wait synchronously for the result of the pipeline execution.
timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property timeout: Maximum wait time for pipeline execution in minutes.

organization_idRequired 

organization_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

pipeline_idRequired 

pipeline_id: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

paramsOptional 

params: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.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 

sync: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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 

timeout: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.