View a markdown version of this page

AWS::CodeBuild::Project PullRequestBuildPolicy - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::CodeBuild::Project PullRequestBuildPolicy

A PullRequestBuildPolicy object that defines comment-based approval requirements for triggering builds on pull requests. This policy helps control when automated builds are executed based on contributor permissions and approval workflows.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "ApproverRoles" : [ String, ... ],
  "RequiresCommentApproval" : String
}

YAML

  ApproverRoles: 
    - String
  RequiresCommentApproval: String

Properties

ApproverRoles

List of repository roles that have approval privileges for pull request builds when comment approval is required. Only users with these roles can provide valid comment approvals. If a pull request contributor is one of these roles, their pull request builds will trigger automatically. This field is only applicable when requiresCommentApproval is not DISABLED.

Required: No

Type: Array of String

Update requires: No interruption

RequiresCommentApproval

Specifies when comment-based approval is required before triggering a build on pull requests. This setting determines whether builds run automatically or require explicit approval through comments.

  • DISABLED: Builds trigger automatically without requiring comment approval

  • ALL_PULL_REQUESTS: All pull requests require comment approval before builds execute (unless contributor is one of the approver roles)

  • FORK_PULL_REQUESTS: Only pull requests from forked repositories require comment approval (unless contributor is one of the approver roles)

Required: Yes

Type: String

Allowed values: DISABLED | ALL_PULL_REQUESTS | FORK_PULL_REQUESTS

Update requires: No interruption