Documentation - v0.0.0
    Preparing search index...

    Interface CloudFrontRewriteFunctionProps

    Props for HandlerLambdaCloudFrontFunction

    interface CloudFrontRewriteFunctionProps {
        autoPublish?: boolean;
        comment?: string;
        fromHostname: string;
        functionName?: string;
        keyValueStore?: IKeyValueStore;
        redirectUriPattern: string;
        runtime?: FunctionRuntime;
        targetUriPattern: string;
        toHostname: string;
    }

    Hierarchy

    • Omit<cloudfront.FunctionProps, "code">
      • CloudFrontRewriteFunctionProps
    Index

    Properties

    autoPublish? comment? fromHostname functionName? keyValueStore? redirectUriPattern runtime? targetUriPattern toHostname

    Properties

    autoPublish?: boolean

    A flag that determines whether to automatically publish the function to the LIVE stage when it’s created.

    - true
    comment?: string

    A comment to describe the function.

    • same as functionName
    fromHostname: string

    The hostname to rewrite from.

    functionName?: string

    A name to identify the function.

    • generated from the id
    keyValueStore?: IKeyValueStore

    The Key Value Store to associate with this function.

    In order to associate a Key Value Store, the runtime must be cloudfront-js-2.0 or newer.

    - no key value store is associated
    redirectUriPattern: string

    The redirect URI match pattern used for substitution.

    runtime?: FunctionRuntime

    The runtime environment for the function.

    FunctionRuntime.JS_1_0 (unless keyValueStore is specified, then FunctionRuntime.JS_2_0)

    targetUriPattern: string

    Target URI pattern for substitution.

    toHostname: string

    The hostname to rewrite to.

    Settings

    Member Visibility

    On This Page

    Properties