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

Inherits:

Struct

• Object
• Struct
• Aws::CodeBuild::Types::Webhook

Includes:

Structure

Defined in:

lib/aws-sdk-codebuild/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #last_modified_secret ⇒ Time

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

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

• #payload_url ⇒ String

  The CodeBuild endpoint where webhook events are sent.

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

• #secret ⇒ String

  The secret token of the associated repository.

• #status ⇒ String

  The status of the webhook.

• #status_message ⇒ String

  A message associated with the status of a webhook.

• #url ⇒ String

  The URL to the webhook.

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.

<note markdown=“1”> It is recommended that you use ‘filterGroups` instead of `branchFilter`.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :pull_request_build_policy)
  SENSITIVE = []
  include Aws::Structure
end

#build_type ⇒ String

Specifies the type of build this webhook will trigger.

<note markdown=“1”> ‘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][1

in the

*CodeBuild user guide*.

</note>

[1]: docs.aws.amazon.com/codebuild/latest/userguide/sample-runner-buildkite.html

Returns:

• (String)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :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.

Returns:

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

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :pull_request_build_policy)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_secret ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :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.

<note markdown=“1”> manualCreation is only available for GitHub webhooks.

</note>

Returns:

• (Boolean)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :pull_request_build_policy)
  SENSITIVE = []
  include Aws::Structure
end

#payload_url ⇒ String

The CodeBuild endpoint where webhook events are sent.

Returns:

• (String)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :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.

Returns:

• (Types::PullRequestBuildPolicy)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :pull_request_build_policy)
  SENSITIVE = []
  include Aws::Structure
end

#scope_configuration ⇒ Types::ScopeConfiguration

The scope configuration for global or organization webhooks.

<note markdown=“1”> Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

</note>

Returns:

• (Types::ScopeConfiguration)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :pull_request_build_policy)
  SENSITIVE = []
  include Aws::Structure
end

#secret ⇒ String

The secret token of the associated repository.

<note markdown=“1”> A Bitbucket webhook does not support ‘secret`.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :pull_request_build_policy)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the webhook. Valid values include:

• ‘CREATING`: The webhook is being created.

• ‘CREATE_FAILED`: The webhook has failed to create.

• ‘ACTIVE`: The webhook has succeeded and is active.

• ‘DELETING`: The webhook is being deleted.

Returns:

• (String)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :pull_request_build_policy)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A message associated with the status of a webhook.

Returns:

• (String)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :pull_request_build_policy)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ String

The URL to the webhook.

Returns:

• (String)

# File 'lib/aws-sdk-codebuild/types.rb', line 8254

class Webhook < Struct.new(
  :url,
  :payload_url,
  :secret,
  :branch_filter,
  :filter_groups,
  :build_type,
  :manual_creation,
  :last_modified_secret,
  :scope_configuration,
  :status,
  :status_message,
  :pull_request_build_policy)
  SENSITIVE = []
  include Aws::Structure
end