Amplify Toolbox
    Preparing search index...

    Type Alias ImageConfig

    type ImageConfig = {
        baseURL?: string;
        bundle: string;
        dangerouslyAllowSVG?: boolean;
        domains?: string[];
        environment?: Record<string, string>;
        formats: string[];
        handler: string;
        minimumCacheTTL?: number;
        remotePatterns?: RemotePattern[];
        sizes: number[];
    }
    Index

    Properties

    baseURL? bundle dangerouslyAllowSVG? domains? environment? formats handler minimumCacheTTL? remotePatterns? sizes

    Properties

    baseURL?: string

    Path prefix the image-opt Lambda serves. Defaults to /_ipx for Nitro/@nuxt/image projects; users can override via runtimeConfig.ipx.baseURL in nuxt.config. The CloudFront cache behavior is wired at this path, and the Lambda's request handler uses it to strip the prefix before passing the URL to IPX.

    bundle: string

    Path to image optimization bundle

    dangerouslyAllowSVG?: boolean

    Permit SVG sources through the image-opt pipeline. SVG can carry arbitrary script payloads; off by default. Mirrors Next.js images.dangerouslyAllowSVG.

    domains?: string[]

    Allowlist of remote image hostnames the image-opt service should fetch from. Mirrors Astro's image.domains and Next.js's images.domains. Forward-compat: the L3 does not consume this yet — adapters write it for parity with the originating framework config.

    environment?: Record<string, string>

    Extra environment variables forwarded to the image-opt Lambda. The L3 always sets BUCKET_NAME / BUCKET_REGION / BUCKET_KEY_PREFIX for storage access; this is for framework-specific config (e.g. IPX_BASE_URL when the user customizes the /_ipx prefix).

    formats: string[]

    Supported formats

    handler: string

    Handler entry point

    minimumCacheTTL?: number

    Minimum cache TTL (in seconds) the image-opt response should advertise. Mirrors Next.js images.minimumCacheTTL. Wired onto the image-opt Lambda's env at L3 time.

    remotePatterns?: RemotePattern[]

    More expressive allowlist than domains. Each entry can scope the match by protocol/port/path prefix in addition to hostname. Mirrors Next.js images.remotePatterns.

    sizes: number[]

    Max image sizes

    Settings

    Member Visibility

    On This Page

    Properties