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.

Syntax

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

JSON

{
  "Condition" : String,
  "Source" : String,
  "Status" : String,
  "Target" : String
}

YAML

  Condition: String
  Source: String
  Status: String
  Target: String

Properties

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