Class CodePipelineSourceAbstract

Readonly isSource

produceAction

• produceAction(stage, options): CodePipelineActionFactoryResult

• Create the desired Action and add it to the pipeline

  Parameters

  • stage: IStage
  • options: ProduceActionOptions

  Returns CodePipelineActionFactoryResult

sourceAttribute

• sourceAttribute(name): string

• Return an attribute of the current source revision

  These values can be passed into the environment variables of pipeline steps, so your steps can access information about the source revision.

  Pipeline synth step has some source attributes predefined in the environment. If these suffice, you don't need to use this method for the synth step.

  Parameters

  • name: string

  Returns string

  See

  • https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html

  What attributes are available depends on the type of source. These attributes are supported:

  • GitHub, CodeCommit, and CodeStarSourceConnection
    • AuthorDate
    • BranchName
    • CommitId
    • CommitMessage
  • GitHub, CodeCommit and ECR
    • RepositoryName
  • GitHub and CodeCommit
    • CommitterDate
  • GitHub
    • CommitUrl
  • CodeStarSourceConnection
    • FullRepositoryName
  • S3
    • ETag
    • VersionId
  • ECR
    • ImageDigest
    • ImageTag
    • ImageURI
    • RegistryId
  • https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-variables.html#reference-variables-list

  Example

  // Access the CommitId of a GitHub source in the synth
  const source = pipelines.CodePipelineSource.gitHub('owner/repo', 'main');
  
  const pipeline = new pipelines.CodePipeline(scope, 'MyPipeline', {
    synth: new pipelines.ShellStep('Synth', {
      input: source,
      commands: [],
      env: {
        'COMMIT_ID': source.sourceAttribute('CommitId'),
      }
    })
  });
  Copy

Static codeCommit

• codeCommit(repository, branch, props?): CodePipelineSource

• Returns a CodeCommit source.

  If you need access to symlinks or the repository history, be sure to set codeBuildCloneOutput.

  Parameters

  • repository: IRepository

    The CodeCommit repository.
  • branch: string

    The branch to use.
  • Optional props: CodeCommitSourceOptions

    The source properties.

  Returns CodePipelineSource

  Example

  declare const repository: codecommit.IRepository;
  pipelines.CodePipelineSource.codeCommit(repository, 'main');
  Copy

Static connection

• connection(repoString, branch, props): CodePipelineSource

• Returns a CodeStar connection source. A CodeStar connection allows AWS CodePipeline to access external resources, such as repositories in GitHub, GitHub Enterprise or BitBucket.

  To use this method, you first need to create a CodeStar connection using the AWS console. In the process, you may have to sign in to the external provider -- GitHub, for example -- to authorize AWS to read and modify your repository. Once you have done this, copy the connection ARN and use it to create the source.

  Example:

  pipelines.CodePipelineSource.connection('owner/repo', 'main', {
    connectionArn: 'arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41', // Created using the AWS console
  });
  Copy

  If you need access to symlinks or the repository history, be sure to set codeBuildCloneOutput.

  Parameters

  • repoString: string

    A string that encodes owner and repository separated by a slash (e.g. 'owner/repo'). The provided string must be resolvable at runtime.
  • branch: string

    The branch to use.
  • props: ConnectionSourceOptions

    The source properties, including the connection ARN.

  Returns CodePipelineSource

  See

  https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html

Static ecr

• ecr(repository, props?): CodePipelineSource

• Returns an ECR source.

  Parameters

  • repository: IRepository

    The repository that will be watched for changes.
  • Optional props: ECRSourceOptions

    The options, which include the image tag to be checked for changes.

  Returns CodePipelineSource

  Example

  declare const repository: ecr.IRepository;
  pipelines.CodePipelineSource.ecr(repository, {
    imageTag: 'latest',
  });
  Copy

Static gitHub

• gitHub(repoString, branch, props?): CodePipelineSource

• Returns a GitHub source, using OAuth tokens to authenticate with GitHub and a separate webhook to detect changes. This is no longer the recommended method. Please consider using connection() instead.

  Pass in the owner and repository in a single string, like this:

  pipelines.CodePipelineSource.gitHub('owner/repo', 'main');
  Copy

  Authentication will be done by a secret called github-token in AWS Secrets Manager (unless specified otherwise).

  If you rotate the value in the Secret, you must also change at least one property on the Pipeline, to force CloudFormation to re-read the secret.

  The token should have these permissions:

  • repo - to read the repository
  • admin:repo_hook - if you plan to use webhooks (true by default)

  If you need access to symlinks or the repository history, use a source of type connection instead.

  Parameters

  • repoString: string
  • branch: string
  • Optional props: GitHubSourceOptions

  Returns CodePipelineSource

Static s3

• s3(bucket, objectKey, props?): CodePipelineSource

• Returns an S3 source.

  Parameters

  • bucket: IBucket

    The bucket where the source code is located.
  • objectKey: string
  • Optional props: S3SourceOptions

    The options, which include the key that identifies the source code file and and how the pipeline should be triggered.

  Returns CodePipelineSource

  Example

  declare const bucket: s3.Bucket;
  pipelines.CodePipelineSource.s3(bucket, 'path/to/file.zip');
  Copy