Skip to content

UpdateWebhookInput

Source code in docs_src/capo_codebuild/types/update_webhook_input.py
class UpdateWebhookInput(TypedDict, closed=True):
    project_name: "capo_codebuild.types.project_name.ProjectName"
    """<p>The name of the CodeBuild project.</p>"""
    branch_filter: NotRequired["capo_codebuild.types.string.String"]
    """<p>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 <code>branchFilter</code> is empty, then all branches are built.</p> <note> <p> It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </p> </note>"""
    rotate_secret: "capo_codebuild.types.boolean.Boolean"
    """<p> A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, <code>rotateSecret</code> is ignored. </p>"""
    filter_groups: NotRequired["capo_codebuild.types.filter_groups.FilterGroups"]
    """<p> An array of arrays of <code>WebhookFilter</code> objects used to determine if a webhook event can trigger a build. A filter group must contain at least one <code>EVENT</code> <code>WebhookFilter</code>. </p>"""
    build_type: NotRequired["capo_codebuild.types.webhook_build_type.WebhookBuildType"]
    """<p>Specifies the type of build this webhook will trigger.</p> <note> <p> <code>RUNNER_BUILDKITE_BUILD</code> is only available for <code>NO_SOURCE</code> source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-runner-buildkite.html">Tutorial: Configure a CodeBuild-hosted Buildkite runner</a> in the <i>CodeBuild user guide</i>.</p> </note>"""
    pull_request_build_policy: NotRequired[
        "capo_codebuild.types.pull_request_build_policy.PullRequestBuildPolicy"
    ]
    """<p>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.</p>"""

branch_filter instance-attribute

branch_filter: NotRequired[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.

It is recommended that you use filterGroups instead of branchFilter.

build_type instance-attribute

build_type: NotRequired[WebhookBuildType]

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.

filter_groups instance-attribute

filter_groups: NotRequired[FilterGroups]

An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

project_name instance-attribute

project_name: ProjectName

The name of the CodeBuild project.

pull_request_build_policy instance-attribute

pull_request_build_policy: NotRequired[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.

rotate_secret instance-attribute

rotate_secret: Boolean

A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.