libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodePipeline.Types.WebhookFilterRule

Description

 
Synopsis

Documentation

data WebhookFilterRule Source #

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

See: newWebhookFilterRule smart constructor.

Constructors

WebhookFilterRule' 

Fields

  • matchEquals :: Maybe Text

    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 "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

  • jsonPath :: Text

    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.

Instances

Instances details
Eq WebhookFilterRule Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.WebhookFilterRule

Read WebhookFilterRule Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.WebhookFilterRule

Show WebhookFilterRule Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.WebhookFilterRule

Generic WebhookFilterRule Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.WebhookFilterRule

Associated Types

type Rep WebhookFilterRule :: Type -> Type #

NFData WebhookFilterRule Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.WebhookFilterRule

Methods

rnf :: WebhookFilterRule -> () #

Hashable WebhookFilterRule Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.WebhookFilterRule

ToJSON WebhookFilterRule Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.WebhookFilterRule

FromJSON WebhookFilterRule Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.WebhookFilterRule

type Rep WebhookFilterRule Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.WebhookFilterRule

type Rep WebhookFilterRule = D1 ('MetaData "WebhookFilterRule" "Amazonka.CodePipeline.Types.WebhookFilterRule" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "WebhookFilterRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "matchEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jsonPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newWebhookFilterRule Source #

Create a value of WebhookFilterRule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:matchEquals:WebhookFilterRule', webhookFilterRule_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 "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

$sel:jsonPath:WebhookFilterRule', webhookFilterRule_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.

webhookFilterRule_matchEquals :: Lens' WebhookFilterRule (Maybe Text) Source #

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 "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

webhookFilterRule_jsonPath :: Lens' WebhookFilterRule Text Source #

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.