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

Inherits:

Struct

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

show all

Includes:: Structure

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

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#json_path ⇒ String

A JsonPath expression that is 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.

Instance Attribute Details

#json_path ⇒ `String`

A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the ‘MatchEquals` field. Otherwise, the request is ignored. For more information, see [Java JsonPath implementation] in GitHub.

[1]: github.com/json-path/JsonPath

Returns:

(String)

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

class WebhookFilterRule < Struct.new(
  :json_path,
  :match_equals)
  SENSITIVE = []
  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 is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. 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 “main”, the `MatchEquals` value is evaluated as “refs/heads/main”. For a list of action configuration properties for built-in action types, see [Pipeline Structure Reference Action Requirements].

[1]: docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements