PipelineDeclaration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codepipeline/refs/heads/main/json-schema/amazon-codepipeline-pipeline-declaration-schema.json",
  "title": "PipelineDeclaration",
  "description": "Represents the structure of actions and stages to be performed in the pipeline.",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipelineName"
        },
        {
          "description": "The name of the pipeline."
        }
      ]
    },
    "roleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no <code>actionRoleArn</code>, or to use to assume roles for actions with an <code>actionRoleArn</code>."
        }
      ]
    },
    "artifactStore": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArtifactStore"
        },
        {
          "description": "<p>Represents information about the S3 bucket where artifacts are stored for the pipeline.</p> <note> <p>You must include either <code>artifactStore</code> or <code>artifactStores</code> in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use <code>artifactStores</code>.</p> </note>"
        }
      ]
    },
    "artifactStores": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArtifactStoreMap"
        },
        {
          "description": "<p>A mapping of <code>artifactStore</code> objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.</p> <note> <p>You must include either <code>artifactStore</code> or <code>artifactStores</code> in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use <code>artifactStores</code>.</p> </note>"
        }
      ]
    },
    "stages": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipelineStageDeclarationList"
        },
        {
          "description": "The stage in which to perform the action."
        }
      ]
    },
    "version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipelineVersion"
        },
        {
          "description": "The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated."
        }
      ]
    }
  },
  "required": [
    "name",
    "roleArn",
    "stages"
  ]
}