You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeBuild::Types::CreateWebhookInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateWebhookInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  project_name: "ProjectName", # required
  branch_filter: "String",
  filter_groups: [
    [
      {
        type: "EVENT", # required, accepts EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH, COMMIT_MESSAGE
        pattern: "String", # required
        exclude_matched_pattern: false,
      },
    ],
  ],
  build_type: "BUILD", # accepts BUILD, BUILD_BATCH
}

See Also:

Instance Attribute Summary collapse

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.

It is recommended that you use filterGroups instead of branchFilter.

Returns:

  • (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.

Possible values:

  • BUILD
  • BUILD_BATCH

Returns:

  • (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. 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.

Returns:

  • (Array<Array<Types::WebhookFilter>>) —

    An array of arrays of WebhookFilter objects used to determine which webhooks are triggered.

#project_name ⇒ String

The name of the AWS CodeBuild project.

Returns:

  • (String) —

    The name of the AWS CodeBuild project.