AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Represents information about a webhook and its definition.

Inheritance Hierarchy

System.Object
  Amazon.CodePipeline.Model.WebhookDefinition

Namespace: Amazon.CodePipeline.Model
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z

Syntax

C#
public class WebhookDefinition

The WebhookDefinition type exposes the following members

Constructors

NameDescription
Public Method WebhookDefinition()

Properties

NameTypeDescription
Public Property Authentication Amazon.CodePipeline.WebhookAuthenticationType

Gets and sets the property Authentication.

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

Public Property AuthenticationConfiguration Amazon.CodePipeline.Model.WebhookAuthConfiguration

Gets and sets the property AuthenticationConfiguration.

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Public Property Filters System.Collections.Generic.List<Amazon.CodePipeline.Model.WebhookFilterRule>

Gets and sets the property Filters.

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

Public Property Name System.String

Gets and sets the property Name.

The name of the webhook.

Public Property TargetAction System.String

Gets and sets the property TargetAction.

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.

Public Property TargetPipeline System.String

Gets and sets the property TargetPipeline.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5