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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#branch_filterString

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)


7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
# File 'lib/aws-sdk-codebuild/types.rb', line 7047

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

#build_typeString

Specifies the type of build this webhook will trigger.

Returns:

  • (String)


7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
# File 'lib/aws-sdk-codebuild/types.rb', line 7047

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

#filter_groupsArray<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:



7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
# File 'lib/aws-sdk-codebuild/types.rb', line 7047

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

#last_modified_secretTime

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

Returns:

  • (Time)


7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
# File 'lib/aws-sdk-codebuild/types.rb', line 7047

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

#manual_creationBoolean

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)


7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
# File 'lib/aws-sdk-codebuild/types.rb', line 7047

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

#payload_urlString

The CodeBuild endpoint where webhook events are sent.

Returns:

  • (String)


7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
# File 'lib/aws-sdk-codebuild/types.rb', line 7047

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

#scope_configurationTypes::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>


7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
# File 'lib/aws-sdk-codebuild/types.rb', line 7047

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

#secretString

The secret token of the associated repository.

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

</note>

Returns:

  • (String)


7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
# File 'lib/aws-sdk-codebuild/types.rb', line 7047

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

#urlString

The URL to the webhook.

Returns:

  • (String)


7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
# File 'lib/aws-sdk-codebuild/types.rb', line 7047

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