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

Class: Aws::CodePipeline::Types::WebhookFilterRule

Inherits:

Struct

Object
Struct
Aws::CodePipeline::Types::WebhookFilterRule

show all

Defined in:: gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb

Overview

Note:

When making an API call, you may pass WebhookFilterRule data as a hash:

{
  json_path: "JsonPath", # required
  match_equals: "MatchEquals",
}

The event criteria that specify when a webhook notification is sent to your URL.

Instance Attribute Summary collapse

#json_path ⇒ String
A JsonPath expression that will be applied to the body/payload of the webhook.
#match_equals ⇒ String
The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored.

Instance Attribute Details

#json_path ⇒ `String`

A JsonPath expression that will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.

Returns:

(String)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3654

class WebhookFilterRule < Struct.new(
  :json_path,
  :match_equals)
  include Aws::Structure
end

#match_equals ⇒ `String`

The value selected by the JsonPath expression must match what is supplied in the MatchEquals field, otherwise the request will be ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly braces. For example, if the value supplied here is "refs/heads/{Branch\}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value will be evaluated as "refs/heads/master". A list of action configuration properties for built-in action types can be found here: Pipeline Structure Reference Action Requirements.