AWS::Amplify::Webhook

Amplify Webhook

Resource Type definition for AWS::Amplify::Webhook. Creates a webhook on an Amplify app.

Properties

4 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`BranchName`	`string`	Required
`AppId`	`string`	Create-onlyWrite-only
`Description`	`string`
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) for the webhook.
`WebhookId`	`string`	The unique ID for a webhook.
`WebhookUrl`	`string`	The URL of the webhook.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Amplify::Webhook

Resources:
  MyResource:
    Type: AWS::Amplify::Webhook
    Properties:
      BranchName: "my-branchname"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

amplify:CreateWebhookamplify:GetWebhookamplify:TagResource

read

amplify:GetWebhookamplify:ListTagsForResource

update

amplify:UpdateWebhookamplify:GetWebhookamplify:TagResourceamplify:UntagResourceamplify:ListTagsForResource

delete

amplify:DeleteWebhookamplify:GetWebhook

list

amplify: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

ServiceAmplify

Properties7

Required1

TaggingSupported

Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

AppId

Related Resources

External Links

AWS Documentation