interface CfnWebhookProps

Language	Type name
.NET	`Amazon.CDK.AWS.CodePipeline.CfnWebhookProps`
Java	`software.amazon.awscdk.services.codepipeline.CfnWebhookProps`
Python	`aws_cdk.aws_codepipeline.CfnWebhookProps`
TypeScript	`@aws-cdk/aws-codepipeline` » `CfnWebhookProps`

Properties for defining a CfnWebhook.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codepipeline from '@aws-cdk/aws-codepipeline';
const cfnWebhookProps: codepipeline.CfnWebhookProps = {
  authentication: 'authentication',
  authenticationConfiguration: {
    allowedIpRange: 'allowedIpRange',
    secretToken: 'secretToken',
  },
  filters: [{
    jsonPath: 'jsonPath',

    // the properties below are optional
    matchEquals: 'matchEquals',
  }],
  targetAction: 'targetAction',
  targetPipeline: 'targetPipeline',
  targetPipelineVersion: 123,

  // the properties below are optional
  name: 'name',
  registerWithThirdParty: false,
};

Properties

Name	Type	Description
authentication	`string`	Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
authenticationConfiguration	`IResolvable` `\|` `WebhookAuthConfigurationProperty`	Properties that configure the authentication applied to incoming webhook trigger requests.
filters	`IResolvable` `\|` `IResolvable` `\|` `WebhookFilterRuleProperty[]`	A list of rules applied to the body/payload sent in the POST request to a webhook URL.
targetAction	`string`	The name of the action in a pipeline you want to connect to the webhook.
targetPipeline	`string`	The name of the pipeline you want to connect to the webhook.
targetPipelineVersion	`number`	The version number of the pipeline to be connected to the trigger request.
name?	`string`	The name of the webhook.
registerWithThirdParty?	`boolean \|` `IResolvable`	Configures a connection between the webhook that was created and the external tool with events to be detected.

authentication

Type: string

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.

authenticationConfiguration

Type: IResolvable | WebhookAuthConfigurationProperty

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.

filters

Type: IResolvable | IResolvable | WebhookFilterRuleProperty[]

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.

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.

targetPipeline

Type: string

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

targetPipelineVersion

Type: number

The version number of the pipeline to be connected to the trigger request.

Required: Yes

Type: Integer

Update requires: No interruption

name?

Type: string (optional)

The name of the webhook.

registerWithThirdParty?

Type: boolean | IResolvable (optional)

Configures a connection between the webhook that was created and the external tool with events to be detected.