AWS Fundamentals Logo
AWS Fundamentals
AWS::CodePipeline::Webhook

CodePipeline Webhook

Resource Type definition for AWS::CodePipeline::Webhook

Properties

8 configurable properties. 5 required. Click a row to see details.

Filter:
PropertyTypeFlags
Authentication
string
Required
AuthenticationConfiguration
WebhookAuthConfiguration
Required
Filters
Array<WebhookFilterRule>
Required
TargetAction
string
Required
TargetPipeline
string
Required
Name
string
Create-only
RegisterWithThirdParty
boolean
Write-only
TargetPipelineVersion
integer
Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Idstringlogical id of the webhook
UrlstringThe webhook URL generated by AWS CodePipeline

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CodePipeline::Webhook

Resources:
  MyResource:
    Type: AWS::CodePipeline::Webhook
    Properties:
      AuthenticationConfiguration: "value"
      Filters: []
      Authentication: "GITHUB_HMAC"
      TargetPipeline: "value"
      TargetAction: "value"
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

codepipeline:ListWebhookscodepipeline:RegisterWebhookWithThirdPartycodepipeline:PutWebhook

read

codepipeline:ListWebhooks

update

codepipeline:ListWebhookscodepipeline:RegisterWebhookWithThirdPartycodepipeline:PutWebhookcodepipeline:DeregisterWebhookWithThirdParty

delete

codepipeline:ListWebhookscodepipeline:DeleteWebhookcodepipeline:DeregisterWebhookWithThirdParty

list

codepipeline:ListWebhooks

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceCodePipeline
Properties10
Required5
TaggingNot supported
Primary IDId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

Name

Related Resources

External Links