AWS Amplify Console Webhook

This page shows how to write Terraform and CloudFormation for Amplify Console Webhook and write them securely.

code-icon

Fix issues in your cloud & app configurations

Test for misconfigurations of this resource in your cloud.

get-started-button

Terraform Example (aws_amplify_webhook)

Provides an Amplify Webhook resource.

Parameters

The following arguments are supported:

  • app_id - (Required) The unique ID for an Amplify app.
  • branch_name - (Required) The name for a branch that is part of the Amplify app.
  • description - (Optional) The description for a webhook.

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

  • arn - The Amazon Resource Name (ARN) for the webhook.
  • url - The URL of the webhook.

Example Usage (from GitHub)

An example could not be found in GitHub.

CloudFormation Example (AWS::Amplify::App CustomRule)

The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies. Redirects enable a web app to reroute navigation from one URL to another.

Parameters

Condition The condition for a URL rewrite or redirect rule, such as a country code.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: (?s).*
Required: No
Type: String
Update requires: No interruption

Source The source pattern for a URL rewrite or redirect rule.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: (?s).+
Required: Yes
Type: String
Update requires: No interruption

Status The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
302
Represents a 302 temporary redirect rule.
404
Represents a 404 redirect rule.
404-200
Represents a 404 rewrite rule. Length Constraints: Minimum length of 3. Maximum length of 7.
Pattern: .{3,7}
Required: No
Type: String
Update requires: No interruption

Target The target pattern for a URL rewrite or redirect rule.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: (?s).+
Required: Yes
Type: String
Update requires: No interruption

Frequently asked questions

What is AWS Amplify Console Webhook?

AWS Amplify Console Webhook is a resource for Amplify Console of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.