Class: Aws::CodeBuild::Types::CreateWebhookInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodeBuild::Types::CreateWebhookInput
- Defined in:
- gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#branch_filter ⇒ String
A regular expression used to determine which repository branches are built when a webhook is triggered.
-
#build_type ⇒ String
Specifies the type of build this webhook will trigger.
-
#filter_groups ⇒ Array<Array<Types::WebhookFilter>>
An array of arrays of
WebhookFilter
objects used to determine which webhooks are triggered. -
#manual_creation ⇒ Boolean
If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns
payloadUrl
andsecret
values for the webhook. -
#project_name ⇒ String
The name of the CodeBuild project.
-
#pull_request_build_policy ⇒ Types::PullRequestBuildPolicy
A PullRequestBuildPolicy object that defines comment-based approval requirements for triggering builds on pull requests.
-
#scope_configuration ⇒ Types::ScopeConfiguration
The scope configuration for global or organization webhooks.
Instance Attribute Details
#branch_filter ⇒ String
A regular expression used to determine which repository branches are
built when a webhook is triggered. If the name of a branch matches
the regular expression, then it is built. If branchFilter
is
empty, then all branches are built.
filterGroups
instead of
branchFilter
.
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 |
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2216 class CreateWebhookInput < Struct.new( :project_name, :branch_filter, :filter_groups, :build_type, :manual_creation, :scope_configuration, :pull_request_build_policy) SENSITIVE = [] include Aws::Structure end |
#build_type ⇒ String
Specifies the type of build this webhook will trigger.
RUNNER_BUILDKITE_BUILD
is only available for NO_SOURCE
source
type projects configured for Buildkite runner builds. For more
information about CodeBuild-hosted Buildkite runner builds, see
Tutorial: Configure a CodeBuild-hosted Buildkite runner in the
CodeBuild user guide.
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 |
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2216 class CreateWebhookInput < Struct.new( :project_name, :branch_filter, :filter_groups, :build_type, :manual_creation, :scope_configuration, :pull_request_build_policy) SENSITIVE = [] include Aws::Structure end |
#filter_groups ⇒ Array<Array<Types::WebhookFilter>>
An array of arrays of WebhookFilter
objects used to determine
which webhooks are triggered. At least one WebhookFilter
in the
array must specify EVENT
as its type
.
For a build to be triggered, at least one filter group in the
filterGroups
array must pass. For a filter group to pass, each of
its filters must pass.
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 |
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2216 class CreateWebhookInput < Struct.new( :project_name, :branch_filter, :filter_groups, :build_type, :manual_creation, :scope_configuration, :pull_request_build_policy) SENSITIVE = [] include Aws::Structure end |
#manual_creation ⇒ Boolean
If manualCreation is true, CodeBuild doesn't create a webhook in
GitHub and instead returns payloadUrl
and secret
values for the
webhook. The payloadUrl
and secret
values in the output can be
used to manually create a webhook within GitHub.
manualCreation
is only available for GitHub webhooks.
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 |
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2216 class CreateWebhookInput < Struct.new( :project_name, :branch_filter, :filter_groups, :build_type, :manual_creation, :scope_configuration, :pull_request_build_policy) SENSITIVE = [] include Aws::Structure end |
#project_name ⇒ String
The name of the CodeBuild project.
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 |
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2216 class CreateWebhookInput < Struct.new( :project_name, :branch_filter, :filter_groups, :build_type, :manual_creation, :scope_configuration, :pull_request_build_policy) SENSITIVE = [] include Aws::Structure end |
#pull_request_build_policy ⇒ Types::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.
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 |
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2216 class CreateWebhookInput < Struct.new( :project_name, :branch_filter, :filter_groups, :build_type, :manual_creation, :scope_configuration, :pull_request_build_policy) SENSITIVE = [] include Aws::Structure end |
#scope_configuration ⇒ Types::ScopeConfiguration
The scope configuration for global or organization webhooks.
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 |
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2216 class CreateWebhookInput < Struct.new( :project_name, :branch_filter, :filter_groups, :build_type, :manual_creation, :scope_configuration, :pull_request_build_policy) SENSITIVE = [] include Aws::Structure end |