Package software.amazon.awscdk.services.codepipeline

Interface CfnWebhook.WebhookFilterRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebhook.WebhookFilterRuleProperty.Jsii$Proxy

Enclosing class:

CfnWebhook

@Stability(Stable)
public static interface CfnWebhook.WebhookFilterRuleProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 WebhookFilterRuleProperty webhookFilterRuleProperty = WebhookFilterRuleProperty.builder()
         .jsonPath("jsonPath")
         // the properties below are optional
         .matchEquals("matchEquals")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebhook.WebhookFilterRuleProperty.Builder	A builder for CfnWebhook.WebhookFilterRuleProperty
static final class	CfnWebhook.WebhookFilterRuleProperty.Jsii$Proxy	An implementation for CfnWebhook.WebhookFilterRuleProperty

Method Summary

Modifier and Type	Method	Description
static CfnWebhook.WebhookFilterRuleProperty.Builder	builder()
String	getJsonPath()	A JsonPath expression that is applied to the body/payload of the webhook.
default String	getMatchEquals()	The value selected by the JsonPath expression must match what is supplied in the MatchEquals field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getJsonPath

@Stability(Stable)
@NotNull
String getJsonPath()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-jsonpath

getMatchEquals

@Stability(Stable)
@Nullable
default String getMatchEquals()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-matchequals

builder

@Stability(Stable)
static CfnWebhook.WebhookFilterRuleProperty.Builder builder()

Returns:

a CfnWebhook.WebhookFilterRuleProperty.Builder of CfnWebhook.WebhookFilterRuleProperty