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.

WebhookDefinition

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

type WebhookDefinition struct { Authentication *string `locationName:"authentication" type:"string" required:"true" enum:"WebhookAuthenticationType"` AuthenticationConfiguration *WebhookAuthConfiguration `locationName:"authenticationConfiguration" type:"structure" required:"true"` Filters []*WebhookFilterRule `locationName:"filters" type:"list" required:"true"` Name *string `locationName:"name" min:"1" type:"string" required:"true"` TargetAction *string `locationName:"targetAction" min:"1" type:"string" required:"true"` TargetPipeline *string `locationName:"targetPipeline" min:"1" type:"string" required:"true"` }

Represents information about a webhook and its definition.

Authentication

Type: *string

Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.

  • IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.

Authentication is a required field

AuthenticationConfiguration

The authentication applied to incoming webhook trigger requests.

Filters

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

Name

Type: *string

The name of the webhook.

Name is a required field

TargetAction

Type: *string

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

TargetAction is a required field

TargetPipeline

Type: *string

The name of the pipeline you want to connect to the webhook.

TargetPipeline is a required field

Method

GoString

func (s WebhookDefinition) GoString() string

GoString returns the string representation

SetAuthentication

func (s *WebhookDefinition) SetAuthentication(v string) *WebhookDefinition

SetAuthentication sets the Authentication field's value.

SetAuthenticationConfiguration

func (s *WebhookDefinition) SetAuthenticationConfiguration(v *WebhookAuthConfiguration) *WebhookDefinition

SetAuthenticationConfiguration sets the AuthenticationConfiguration field's value.

SetFilters

func (s *WebhookDefinition) SetFilters(v []*WebhookFilterRule) *WebhookDefinition

SetFilters sets the Filters field's value.

SetName

func (s *WebhookDefinition) SetName(v string) *WebhookDefinition

SetName sets the Name field's value.

SetTargetAction

func (s *WebhookDefinition) SetTargetAction(v string) *WebhookDefinition

SetTargetAction sets the TargetAction field's value.

SetTargetPipeline

func (s *WebhookDefinition) SetTargetPipeline(v string) *WebhookDefinition

SetTargetPipeline sets the TargetPipeline field's value.

String

func (s WebhookDefinition) String() string

String returns the string representation

Validate

func (s *WebhookDefinition) Validate() error

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

On this page: