aws-cdk-lib.aws_amplify.CfnWebhookProps

CfnWebhookProps Struct

Properties for defining a CfnWebhook.

Source

Generated code

Type last changed

v2.268.0 · 2 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplify as amplify } from 'aws-cdk-lib';
const cfnWebhookProps: amplify.CfnWebhookProps = {
  branchName: 'branchName',

  // the properties below are optional
  appId: 'appId',
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

appIdstringapp_idstrappIdStringAppIdstringAppId*string#

The unique ID for an Amplify app.

branchNamestringbranch_namestrbranchNameStringBranchNamestringBranchName*stringrequired#

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

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

The description for a webhook.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

Tags for the webhook.

Used as props by

• CfnWebhook