software.amazon.awscdk.services.amplify

Class CustomRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.amplify.CustomRule

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:22.909Z")
 @Stability(value=Experimental)
public class CustomRule
extends software.amazon.jsii.JsiiObject

(experimental) Custom rewrite/redirect rule for an Amplify App.

Example:

 App amplifyApp;
 amplifyApp.addCustomRule(Map.of(
         "source", "/docs/specific-filename.html",
         "target", "/documents/different-filename.html",
         "status", RedirectStatus.TEMPORARY_REDIRECT));
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomRule.Builder (experimental) A fluent builder for CustomRule.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static CustomRule	SINGLE_PAGE_APPLICATION_REDIRECT (experimental) Sets up a 200 rewrite for all paths to `index.html` except for path containing a file extension.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CustomRule(CustomRuleOptions options)
protected	CustomRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CustomRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
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.
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 class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

SINGLE_PAGE_APPLICATION_REDIRECT

@Stability(value=Experimental)
public static final CustomRule SINGLE_PAGE_APPLICATION_REDIRECT

(experimental) Sets up a 200 rewrite for all paths to `index.html` except for path containing a file extension.

Constructor Detail

CustomRule

protected CustomRule(software.amazon.jsii.JsiiObjectRef objRef)

CustomRule

protected CustomRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CustomRule

@Stability(value=Experimental)
public CustomRule(@NotNull
                                                 CustomRuleOptions options)

Parameters:

options - This parameter is required.

Method Detail

getSource

@Stability(value=Experimental)
 @NotNull
public 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(value=Experimental)
 @NotNull
public 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(value=Experimental)
 @Nullable
public 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(value=Experimental)
 @Nullable
public 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