AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateWebhook operation. For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.

If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CodeBuild.AmazonCodeBuildRequest
      Amazon.CodeBuild.Model.CreateWebhookRequest

Namespace: Amazon.CodeBuild.Model
Assembly: AWSSDK.CodeBuild.dll
Version: 3.x.y.z

Syntax

C# 
public class CreateWebhookRequest : AmazonCodeBuildRequest
         IAmazonWebServiceRequest

The CreateWebhookRequest type exposes the following members

Constructors

NameDescription
Public Method CreateWebhookRequest()

Properties

NameTypeDescription
Public Property BranchFilter System.String

Gets and sets the property BranchFilter.

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.

Public Property BuildType Amazon.CodeBuild.WebhookBuildType

Gets and sets the property BuildType.

Specifies the type of build this webhook will trigger.

Public Property FilterGroups System.Collections.Generic.List<System.Collections.Generic.List<Amazon.CodeBuild.Model.WebhookFilter>>

Gets and sets the property FilterGroups.

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.

Public Property ManualCreation System.Boolean

Gets and sets the property ManualCreation.

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.

Public Property ProjectName System.String

Gets and sets the property ProjectName.

The name of the CodeBuild project.

Public Property ScopeConfiguration Amazon.CodeBuild.Model.ScopeConfiguration

Gets and sets the property ScopeConfiguration.

The scope configuration for global or organization webhooks.

Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5