Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/aws-copilot-manifest/_shared/latest--pipeline.json
Parent schema aws-copilot-manifest
Type: object

Properties

name string required

The name of your pipeline.

pattern=^[a-zA-Z][a-zA-Z0-9-]*$
source object required

Configuration for how your pipeline is triggered.

2 nested properties
provider string required

The name of your provider. Currently, GitHub, Bitbucket, and CodeCommit are supported.

Values: "GitHub" "Bitbucket" "CodeCommit"
properties object required
5 nested properties
branch string required

The name of the branch in your repository that triggers the pipeline.

repository string required

The URL of your repository.

access_token_secret string

The name of AWS Secrets Manager secret that holds the GitHub access token to trigger the pipeline if your provider is GitHub and you created your pipeline with a personal access token.

connection_name string

The name of an existing CodeStar Connections connection. If omitted, Copilot will generate a connection for you.

output_artifact_format string

Optional. The output artifact format. Values can be either CODEBUILD_CLONE_REF or CODE_ZIP. If omitted, the default is CODE_ZIP.

Values: "CODEBUILD_CLONE_REF" "CODE_ZIP"
stages object[] required

Ordered list of environments that your pipeline will deploy to.

minItems=1
version integer

The schema version for the template. There is only one version, 1, supported at the moment. (NOTE: The Copilot CLI docs incorrectly specify that this should be a string.)

Values: 1
build object

Configuration for CodeBuild project.

3 nested properties
image string

The URI that identifies the Docker image to use for this build project.

buildspec string

Optional. The path to a buildspec file, relative to the project root, to use for this build project.

additional_policy object
1 nested properties
PolicyDocument object

Specify an additional policy document to add to the build project role.