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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass CreateWebhookInput data as a 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
}

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.

It is recommended that you use filterGroups instead of branchFilter.

Returns:

  • (String)


1906
1907
1908
1909
1910
1911
1912
1913
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1906

class CreateWebhookInput < Struct.new(
  :project_name,
  :branch_filter,
  :filter_groups,
  :build_type)
  SENSITIVE = []
  include Aws::Structure
end

#build_typeString

Specifies the type of build this webhook will trigger.

Returns:

  • (String)


1906
1907
1908
1909
1910
1911
1912
1913
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1906

class CreateWebhookInput < Struct.new(
  :project_name,
  :branch_filter,
  :filter_groups,
  :build_type)
  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:



1906
1907
1908
1909
1910
1911
1912
1913
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1906

class CreateWebhookInput < Struct.new(
  :project_name,
  :branch_filter,
  :filter_groups,
  :build_type)
  SENSITIVE = []
  include Aws::Structure
end

#project_nameString

The name of the CodeBuild project.

Returns:

  • (String)


1906
1907
1908
1909
1910
1911
1912
1913
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1906

class CreateWebhookInput < Struct.new(
  :project_name,
  :branch_filter,
  :filter_groups,
  :build_type)
  SENSITIVE = []
  include Aws::Structure
end