builder util runtime.Interface.S3Options

Electron-Builder / builder-util-runtime / S3Options

Amazon S3 options. AWS credentials are required, please see getting your credentials. To set credentials define AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables directly, or use ~/.aws/credentials file, or use ~/.aws/config file. For the last method to work you will also need to define AWS_SDK_LOAD_CONFIG=1 environment variable.

Example configuration:

{
 "build":
   "publish": {
     "provider": "s3",
     "bucket": "bucket-name"
   }
 }
}

Extends¶

BaseS3Options

Properties¶

accelerate?¶

readonly optional accelerate: boolean

If set to true, this will enable the s3 accelerated endpoint These endpoints have a particular format of: ${bucketname}.s3-accelerate.amazonaws.com

acl?¶

readonly optional acl: null | "private" | "public-read"

The ACL. Set to null to not add.

Please see required permissions for the S3 provider.

Default¶

public-read

Overrides¶

BaseS3Options.acl

bucket¶

readonly bucket: string

The bucket name.

channel?¶

optional channel: null | string

The update channel.

Default¶

latest

Inherited from¶

BaseS3Options.channel

encryption?¶

readonly optional encryption: null | "AES256" | "aws:kms"

Server-side encryption algorithm to use for the object.

endpoint?¶

readonly optional endpoint: null | string

The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like https://{service}.{region}.amazonaws.com.

forcePathStyle?¶

readonly optional forcePathStyle: boolean

When true, force a path-style endpoint to be used where the bucket name is part of the path. Path-style Access

path?¶

readonly optional path: null | string

The directory path.

Default¶

Inherited from¶

BaseS3Options.path

provider¶

readonly provider: "s3"

The provider. Must be s3.

Overrides¶

BaseS3Options.provider

publishAutoUpdate?¶

readonly optional publishAutoUpdate: boolean

Whether to publish auto update info files.

Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.

Default¶

true

Inherited from¶

BaseS3Options.publishAutoUpdate

region?¶

optional region: null | string

The region. Is determined and set automatically when publishing.

requestHeaders?¶

readonly optional requestHeaders: OutgoingHttpHeaders

Any custom request headers

Inherited from¶

BaseS3Options.requestHeaders

storageClass?¶

readonly optional storageClass: null | "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA"

The type of storage to use for the object.

Default¶

STANDARD

timeout?¶

readonly optional timeout: null | number

Request timeout in milliseconds. (Default is 2 minutes; O is ignored)

Default¶

Inherited from¶

BaseS3Options.timeout