All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::DEVOPS::PipelineRelations

Last Updated:Nov 27, 2023

ALIYUN::DEVOPS::PipelineRelations is used to associate resources with a pipeline.

Syntax

{
  "Type": "ALIYUN::DEVOPS::PipelineRelations",
  "Properties": {
    "RelObjectType": String,
    "RelObjectIds": List,
    "PipelineId": Number,
    "OrganizationId": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

RelObjectType

String

Yes

No

The type of the resources.

Set the value to VARIABLE_GROUP.

RelObjectIds

List

Yes

No

The IDs of the resources.

Only variable group IDs are supported.

PipelineId

Number

Yes

No

The pipeline ID.

You can obtain the pipeline ID from the pipeline URL. Sample pipeline URL: https://flow.aliyun.com/pipelines/[PipelineId]/current.

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: https:// devops.aliyun.com/organization/[OrgId].

Return values

Fn::GetAtt

None.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      OrganizationId:
        Description:
          en: Corporate identity, also known as enterprise id, can obtain in cloud effect
            access links.
        Type: String
      PipelineId:
        Description:
          en: The pipeline ID, which can be obtained from the pipeline link.
        Type: Number
      RelObjectIds:
        AssociationProperty: List[Parameter]
        AssociationPropertyMetadata:
          Parameter:
            Type: Number
        Description:
          en: Ids of the associated resource. For now, only variable group ids are supported.
        Type: Json
      RelObjectType:
        Description:
          en: 'Associated resource type. Valid values:
    
            - VARIABLE_GROUP
    
            - OOS_APP_ID
    
            For now, only VARIABLE GROUP is supported. '
        Type: String
    Resources:
      PipelineRelations:
        Properties:
          OrganizationId:
            Ref: OrganizationId
          PipelineId:
            Ref: PipelineId
          RelObjectIds:
            Ref: RelObjectIds
          RelObjectType:
            Ref: RelObjectType
        Type: ALIYUN::DEVOPS::PipelineRelations
                            
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RelObjectType": {
          "Type": "String",
          "Description": {
            "en": "Associated resource type. Valid values:\n- VARIABLE_GROUP\n- OOS_APP_ID\nFor now, only VARIABLE GROUP is supported. "
          }
        },
        "RelObjectIds": {
          "AssociationPropertyMetadata": {
            "Parameter": {
              "Type": "Number"
            }
          },
          "AssociationProperty": "List[Parameter]",
          "Type": "Json",
          "Description": {
            "en": "Ids of the associated resource. For now, only variable group ids are supported."
          }
        },
        "PipelineId": {
          "Type": "Number",
          "Description": {
            "en": "The pipeline ID, which can be obtained from the pipeline link."
          }
        },
        "OrganizationId": {
          "Type": "String",
          "Description": {
            "en": "Corporate identity, also known as enterprise id, can obtain in cloud effect access links."
          }
        }
      },
      "Resources": {
        "PipelineRelations": {
          "Type": "ALIYUN::DEVOPS::PipelineRelations",
          "Properties": {
            "RelObjectType": {
              "Ref": "RelObjectType"
            },
            "RelObjectIds": {
              "Ref": "RelObjectIds"
            },
            "PipelineId": {
              "Ref": "PipelineId"
            },
            "OrganizationId": {
              "Ref": "OrganizationId"
            }
          }
        }
      }
    }