Class: Aws::CodeBuild::Types::PullRequestBuildPolicy

Inherits:

Struct

Object
Struct
Aws::CodeBuild::Types::PullRequestBuildPolicy

show all

Defined in:: gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#approver_roles ⇒ Array<String>
List of repository roles that have approval privileges for pull request builds when comment approval is required.
#requires_comment_approval ⇒ String
Specifies when comment-based approval is required before triggering a build on pull requests.

Instance Attribute Details

#approver_roles ⇒ `Array<String>`

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.

Returns:

(Array<String>)

# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 5548

class PullRequestBuildPolicy < Struct.new(
  :requires_comment_approval,
  :approver_roles)
  SENSITIVE = []
  include Aws::Structure
end

#requires_comment_approval ⇒ `String`

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)