PipelineDeclaration is a JSON Structure definition published by Amazon CodePipeline, describing 6 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codepipeline/refs/heads/main/json-structure/amazon-codepipeline-pipeline-declaration-structure.json",
"name": "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"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.