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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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.

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

</note>

Returns:

  • (String) 


6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
 
# File 'lib/aws-sdk-codebuild/types.rb', line 6021

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

#build_type ⇒ String

Specifies the type of build this webhook will trigger.

Returns:

  • (String) 


6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
 
# File 'lib/aws-sdk-codebuild/types.rb', line 6021

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



6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
 
# File 'lib/aws-sdk-codebuild/types.rb', line 6021

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


6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
 
# File 'lib/aws-sdk-codebuild/types.rb', line 6021

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

#payload_url ⇒ String

The CodeBuild endpoint where webhook events are sent.

Returns:

  • (String) 


6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
 
# File 'lib/aws-sdk-codebuild/types.rb', line 6021

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


6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
 
# File 'lib/aws-sdk-codebuild/types.rb', line 6021

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

#url ⇒ String

The URL to the webhook.

Returns:

  • (String) 


6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
 
# File 'lib/aws-sdk-codebuild/types.rb', line 6021

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