Documentation
    Preparing search index...

    Interface PublisherS3Config

    interface PublisherS3Config {
        accessKeyId?: string;
        bucket?: string;
        endpoint?: string;
        folder?: string;
        keyResolver?: (
            opts: {
                arch: string;
                fileName: string;
                platform: string;
                version: string;
            },
        ) => string;
        omitAcl?: boolean;
        public?: boolean;
        region?: string;
        releaseFileCacheControlMaxAge?: number;
        s3ForcePathStyle?: boolean;
        secretAccessKey?: string;
        sessionToken?: string;
    }
    Index

    Properties

    accessKeyId? bucket? endpoint? folder? keyResolver? omitAcl? public? region? releaseFileCacheControlMaxAge? s3ForcePathStyle? secretAccessKey? sessionToken?

    Properties

    accessKeyId?: string

    Your AWS Access Key ID

    Falls back to the the default credential provider chain if not provided

    bucket?: string

    The name of the S3 bucket to upload artifacts to

    endpoint?: string

    The endpoint URI to send requests to.

    E.g. https://s3.example.com

    folder?: string

    The key prefix to upload artifacts to.

    E.g. my/prefix

    Default: appVersion

    keyResolver?: (
        opts: {
            arch: string;
            fileName: string;
            platform: string;
            version: string;
        },
    ) => string

    Custom function to provide the key to upload a given file to

    omitAcl?: boolean

    Whether to omit the ACL when creating the S3 object. If set, public will have no effect.

    Default: false

    public?: boolean

    Whether or not to make uploaded artifacts public to the internet

    Default: false

    region?: string

    The region to send service requests to.

    E.g. eu-west-1

    releaseFileCacheControlMaxAge?: number

    Set the Cache-Control max-age metadata in S3 for the RELEASES file

    Default: Cache-Control metadata is not set

    s3ForcePathStyle?: boolean

    Whether to force path style URLs for S3 objects.

    Default: false

    secretAccessKey?: string

    The secret for your AWS Access Key

    Falls back to the the default credential provider chain if not provided

    sessionToken?: string

    The session token for your AWS Access Key

    Falls back to the the default credential provider chain if not provided

    Settings

    Member Visibility

    On This Page

    Properties