software.amazon.awscdk.services.amplify

Class CustomRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.amplify.CustomRule

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:57.447Z")
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.

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
protected	CustomRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CustomRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCondition() (experimental) The condition for a URL rewrite or redirect rule, e.g.
java.lang.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.
java.lang.String	getTarget() (experimental) The target pattern for a URL rewrite or redirect rule.

Methods inherited from class java.lang.Object

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

Field Detail

SINGLE_PAGE_APPLICATION_REDIRECT

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)

Method Detail

getSource

public java.lang.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

public java.lang.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

public java.lang.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

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