GradientEdge CDK Utils
    Preparing search index...

    Interface CloudfrontFunctionProps

    interface CloudfrontFunctionProps {
        autoPublish?: boolean;
        code: FunctionCode;
        comment?: string;
        eventType: string;
        functionFilePath: string;
        functionName?: string;
        keyValueStore?: IKeyValueStoreRef;
        runtime?: FunctionRuntime;
    }

    Hierarchy

    • FunctionProps
      • CloudfrontFunctionProps
    Index

    Properties

    autoPublish? code comment? eventType functionFilePath functionName? keyValueStore? runtime?

    Properties

    autoPublish?: boolean

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

    - true
    code: FunctionCode

    The source code of the function.

    comment?: string

    A comment to describe the function.

    • same as functionName
    eventType: string

    The CloudFront event type that triggers the function (e.g. viewer-request, viewer-response)

    functionFilePath: string

    The file path to the CloudFront function source code

    functionName?: string

    A name to identify the function.

    • generated from the id
    keyValueStore?: IKeyValueStoreRef

    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
    runtime?: FunctionRuntime

    The runtime environment for the function.

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

    Settings

    Member Visibility

    On This Page

    Properties