Package software.amazon.awscdk.services.amplify.alpha

Interface CustomRuleOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomRuleOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:42.655Z")
@Stability(Experimental)
public interface CustomRuleOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for a custom rewrite/redirect rule for an Amplify App.

Example:

 import software.amazon.awscdk.services.amplify.alpha.CustomRule;
 App amplifyApp;
 amplifyApp.addCustomRule(CustomRule.Builder.create()
         .source("/docs/specific-filename.html")
         .target("/documents/different-filename.html")
         .status(RedirectStatus.TEMPORARY_REDIRECT)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CustomRuleOptions.Builder	builder()
default String	getCondition()	(experimental) The condition for a URL rewrite or redirect rule, e.g.
String	getSource()	(experimental) The source pattern for a URL rewrite or redirect rule.
default RedirectStatus	getStatus()	(experimental) The status code for a URL rewrite or redirect rule.
String	getTarget()	(experimental) The target pattern for a URL rewrite or redirect rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSource

@Stability(Experimental)
@NotNull
String getSource()

(experimental) The source pattern for a URL rewrite or redirect rule.

See Also:

• https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html

getTarget

@Stability(Experimental)
@NotNull
String getTarget()

(experimental) The target pattern for a URL rewrite or redirect rule.

See Also:

• https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html

getCondition

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

(experimental) The condition for a URL rewrite or redirect rule, e.g. country code.

Default: - no condition

See Also:

• https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html

getStatus

@Stability(Experimental)
@Nullable
default RedirectStatus getStatus()

(experimental) The status code for a URL rewrite or redirect rule.

Default: PERMANENT_REDIRECT

See Also:

• https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html

builder

@Stability(Experimental)
static CustomRuleOptions.Builder builder()

Returns:

a CustomRuleOptions.Builder of CustomRuleOptions