AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

WebhookFilterRule

import "github.com/aws/aws-sdk-go/service/codepipeline"

type WebhookFilterRule struct { JsonPath *string `locationName:"jsonPath" min:"1" type:"string" required:"true"` MatchEquals *string `locationName:"matchEquals" min:"1" type:"string"` }

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

JsonPath

Type: *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.

JsonPath is a required field

MatchEquals

Type: *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 (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements).

Method

GoString

func (s WebhookFilterRule) GoString() string

GoString returns the string representation

SetJsonPath

func (s *WebhookFilterRule) SetJsonPath(v string) *WebhookFilterRule

SetJsonPath sets the JsonPath field's value.

SetMatchEquals

func (s *WebhookFilterRule) SetMatchEquals(v string) *WebhookFilterRule

SetMatchEquals sets the MatchEquals field's value.

String

func (s WebhookFilterRule) String() string

String returns the string representation

Validate

func (s *WebhookFilterRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: