AWS::CodePipeline::Webhook WebhookFilterRule - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::CodePipeline::Webhook WebhookFilterRule

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "JsonPath" : String,
  "MatchEquals" : String
}

YAML

  JsonPath: String
  MatchEquals: String

Properties

JsonPath

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.

Required: Yes

Type: String

Minimum: 1

Maximum: 150

Update requires: No interruption

MatchEquals

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.

Required: No

Type: String

Minimum: 1

Maximum: 150

Update requires: No interruption