Skip to content

Resource: awsAmplifyWebhook

Provides an Amplify Webhook resource.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsAmplifyAppExample = new aws.amplifyApp.AmplifyApp(this, "example", {
  name: "app",
});
const awsAmplifyBranchMaster = new aws.amplifyBranch.AmplifyBranch(
  this,
  "master",
  {
    appId: awsAmplifyAppExample.id,
    branchName: "master",
  }
);
const awsAmplifyWebhookMaster = new aws.amplifyWebhook.AmplifyWebhook(
  this,
  "master_2",
  {
    appId: awsAmplifyAppExample.id,
    branchName: awsAmplifyBranchMaster.branchName,
    description: "triggermaster",
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsAmplifyWebhookMaster.overrideLogicalId("master");

Argument Reference

The following arguments are supported:

  • appId - (Required) Unique ID for an Amplify app.
  • branchName - (Required) Name for a branch that is part of the Amplify app.
  • description - (Optional) Description for a webhook.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - ARN for the webhook.
  • url - URL of the webhook.

Import

Amplify webhook can be imported using a webhook ID, e.g.,

$ terraform import aws_amplify_webhook.master a26b22a0-748b-4b57-b9a0-ae7e601fe4b1