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

Class: Aws::CodeBuild::Types::Webhook

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

Overview

Information about a webhook that connects repository events to a build project in AWS CodeBuild.

Returned by:

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.

#last_modified_secret ⇒ Time

A timestamp that indicates the last time a repository\'s secret token was modified.

Returns:

  • (Time) —

    A timestamp that indicates the last time a repository\'s secret token was modified.

#payload_url ⇒ String

The AWS CodeBuild endpoint where webhook events are sent.

Returns:

  • (String) —

    The AWS CodeBuild endpoint where webhook events are sent.

#secret ⇒ String

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

Returns:

  • (String) —

    The secret token of the associated repository.

#url ⇒ String

The URL to the webhook.

Returns:

  • (String) —

    The URL to the webhook.