View a markdown version of this page

AWS::Amplify::Webhook - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Amplify::Webhook

Describes a webhook that connects repository events to an Amplify app.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Amplify::Webhook",
  "Properties" : {
      "AppId" : String,
      "BranchName" : String,
      "Description" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Amplify::Webhook
Properties:
  AppId: String
  BranchName: String
  Description: String
  Tags: 
    - Tag

Properties

AppId

The unique ID of an Amplify app.

Required: No

Type: String

Pattern: ^d[a-z0-9]+$

Minimum: 1

Maximum: 20

Update requires: Replacement

BranchName

The name for a branch that is part of an Amplify app.

Required: Yes

Type: String

Pattern: ^(?s).+$

Minimum: 1

Maximum: 255

Update requires: No interruption

Description

The description for a webhook.

Required: No

Type: String

Maximum: 1000

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

WebhookId

The ID of the webhook.

WebhookUrl

The URL of the webhook.