interface CustomRuleProperty

Language	Type name
.NET	Amazon.CDK.AWS.Amplify.CfnApp.CustomRuleProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsamplify#CfnApp_CustomRuleProperty
Java	software.amazon.awscdk.services.amplify.CfnApp.CustomRuleProperty
Python	aws_cdk.aws_amplify.CfnApp.CustomRuleProperty
TypeScript	aws-cdk-lib » aws_amplify » CfnApp » CustomRuleProperty

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html

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 customRuleProperty: amplify.CfnApp.CustomRuleProperty = {
  source: 'source',
  target: 'target',

  // the properties below are optional
  condition: 'condition',
  status: 'status',
};

Properties

Name	Type	Description
source	string	The source pattern for a URL rewrite or redirect rule.
target	string	The target pattern for a URL rewrite or redirect rule.
condition?	string	The condition for a URL rewrite or redirect rule, such as a country code.
status?	string	The status code for a URL rewrite or redirect rule.

---

source

Type: string

The source pattern for a URL rewrite or redirect rule.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-source

---

target

Type: string

The target pattern for a URL rewrite or redirect rule.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-target

---

condition?

Type: string (optional)

The condition for a URL rewrite or redirect rule, such as a country code.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-condition

---

status?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html#cfn-amplify-app-customrule-status