CustomRuleOptions

class aws_cdk.aws_amplify_alpha.CustomRuleOptions(*, source, target, condition=None, status=None)

Bases: object

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

Parameters:

source (str) – (experimental) The source pattern for a URL rewrite or redirect rule.
target (str) – (experimental) The target pattern for a URL rewrite or redirect rule.
condition (Optional[str]) – (experimental) The condition for a URL rewrite or redirect rule, e.g. country code. Default: - no condition
status (Optional[RedirectStatus]) – (experimental) The status code for a URL rewrite or redirect rule. Default: PERMANENT_REDIRECT

Stability:

experimental

ExampleMetadata:

infused

Example:

from aws_cdk.aws_amplify_alpha import CustomRule

# amplify_app: amplify.App

amplify_app.add_custom_rule(CustomRule(
    source="/docs/specific-filename.html",
    target="/documents/different-filename.html",
    status=amplify.RedirectStatus.TEMPORARY_REDIRECT
))