@backblaze-labs/b2-sdk - v0.2.0
    Preparing search index...

    Interface S3PresignObjectUrlOptions

    Common options for S3-compatible presigned object URLs.

    interface S3PresignObjectUrlOptions {
        accountInfo: AccountInfo;
        applicationKey: string;
        applicationKeyId: string;
        bucketName: string;
        expiresIn?: number;
        fileName: string;
        region?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accountInfo applicationKey applicationKeyId bucketName expiresIn? fileName region?

    Properties

    accountInfo: AccountInfo

    The authorized AccountInfo containing the S3 endpoint URL.

    applicationKey: string

    B2 application key (secret). Used as the S3 secretAccessKey.

    applicationKeyId: string

    B2 application key ID. Used as the S3 accessKeyId.

    bucketName: string

    Bucket containing the object.

    expiresIn?: number

    URL validity duration in seconds. Defaults to 3600. Must be an integer from 1 to 604800 (7 days), the AWS Signature Version 4 presign maximum. A presigned URL is a bearer credential for the signed operation; keep this as short as the calling workflow allows.

    fileName: string

    Object key / B2 file name to sign. Keys with path segments exactly . or .. cannot be presigned safely because common URL parsers normalize them before sending the request.

    region?: string

    Override the S3 region. If omitted, extracted from the S3 API URL.

    Settings

    Member Visibility

    On This Page

    Properties