Package software.amazon.awscdk.services.amplify

Interface CfnApp.CustomRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApp.CustomRuleProperty.Jsii$Proxy

Enclosing class:

CfnApp

@Stability(Stable)
public static interface CfnApp.CustomRuleProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplify.*;
 CustomRuleProperty customRuleProperty = CustomRuleProperty.builder()
         .source("source")
         .target("target")
         // the properties below are optional
         .condition("condition")
         .status("status")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApp.CustomRuleProperty.Builder	A builder for CfnApp.CustomRuleProperty
static final class	CfnApp.CustomRuleProperty.Jsii$Proxy	An implementation for CfnApp.CustomRuleProperty

Method Summary

Modifier and Type	Method	Description
static CfnApp.CustomRuleProperty.Builder	builder()
default String	getCondition()	The condition for a URL rewrite or redirect rule, such as a country code.
String	getSource()	The source pattern for a URL rewrite or redirect rule.
default String	getStatus()	The status code for a URL rewrite or redirect rule.
String	getTarget()	The target pattern for a URL rewrite or redirect rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSource

@Stability(Stable)
@NotNull
String getSource()

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

getTarget

@Stability(Stable)
@NotNull
String getTarget()

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

getCondition

@Stability(Stable)
@Nullable
default String getCondition()

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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

builder

@Stability(Stable)
static CfnApp.CustomRuleProperty.Builder builder()

Returns:

a CfnApp.CustomRuleProperty.Builder of CfnApp.CustomRuleProperty