idea-aws
    Preparing search index...

    Interface SignedURLPutOptions

    Options for generating a signed URL to put a file.

    interface SignedURLPutOptions {
        filename?: string;
        metadata?: Record<string, string>;
        secToExp?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    filename? metadata? secToExp?

    Properties

    filename?: string

    The suggested name for the file once it's downloaded/saved. Note: the string is cleaned to ensure maximum compatibility with every OS.

    metadata?: Record<string, string>

    A set of metadata to store, as attributes, with the uploaded file. They travel in the signed URL: the client sends no extra header and can't alter them. S3 constraints:

    • keys are stored lowercase (templateId is read back as templateid): use lowercase keys;
    • prefer ASCII values (e.g. IDs): non-ASCII ones are returned RFC 2047-encoded;
    • keys and values take at most 2 KB altogether: beyond, the client's upload fails (not the URL's generation);
    • the values are readable in the URL: no sensitive data.
    secToExp?: number

    Seconds to URL expiration; default: 180 for GET, 300 for PUT.

    Settings

    Member Visibility

    On This Page

    Properties