AWS codepipeline documentation change
Summary
Added documentation about source overrides with EventBridge input transformer including revision types and configuration requirements
Security assessment
The changes describe feature functionality for source overrides but do not address security vulnerabilities or introduce security-specific documentation.
Diff
diff --git a/codepipeline/latest/userguide/concepts-how-it-works.md b/codepipeline/latest/userguide/concepts-how-it-works.md index b8cdce051..8f805dc8c 100644 --- a//codepipeline/latest/userguide/concepts-how-it-works.md +++ b//codepipeline/latest/userguide/concepts-how-it-works.md @@ -5 +5 @@ -How pipeline executions are startedHow source revisions are processed in pipeline executionsHow pipeline executions are stoppedHow executions are processed in SUPERSEDED modeHow executions are processed in QUEUED modeHow executions are processed in PARALLEL modeManaging Pipeline Flow +How pipeline executions are startedHow source revisions are processed in pipeline executionsHow source overrides work with the EventBridge input transformerHow pipeline executions are stoppedHow executions are processed in SUPERSEDED modeHow executions are processed in QUEUED modeHow executions are processed in PARALLEL modeManaging Pipeline Flow @@ -52,0 +53,36 @@ For pipelines in PARALLEL mode with an S3 source, regardless of the image tag th +## How source overrides work with the EventBridge input transformer + +You can use overrides to start a pipeline with a specific source revision ID that you provide for the pipeline execution. For example, if you want to start a pipeline that will process a specific commit ID from your CodeCommit source, you can add the commit ID as an override when you start your pipeline. + +There are four types of source revision for `revisionType`: + + * `COMMIT_ID` + + * `IMAGE_DIGEST` + + * `S3_OBJECT_VERSION_ID` + + * `S3_OBJECT_KEY` + + + + +###### Note + +For the `COMMIT_ID` and `IMAGE_DIGEST` types of source revisions, the source revision ID applies to all content in the repository, across all branches. + +###### Note + +For the `S3_OBJECT_VERSION_ID` and `S3_OBJECT_KEY` types of source revisions, either of the types can be used independently, or they can be used together to override the source with a specific ObjectKey and VersionID. For `S3_OBJECT_KEY`, the configuration parameter `AllowOverrideForS3ObjectKey` needs to be set to `true`. For more information on S3 source configuration parameters, see [Configuration parameters ](./action-reference-S3.html#action-reference-S3-config). + +You can specify source overrides using the input transformer in EventBridge. Use the input transformer to pass the data as one of the following: + + * You can use the input transformer to pass the data as JSON parameters. + + * You can use the input transformer to pass pipeline variables. + + + + +For examples of passing the data as JSON parameters, see [Amazon ECR source actions and EventBridge resources](./create-cwe-ecr-source.html), [Connecting to Amazon S3 source actions that use EventBridge and AWS CloudTrail](./create-cloudtrail-S3-source.html) for S3, and [CodeCommit source actions and EventBridge](./triggering.html) for CodeCommit. +