Skip to main content

S3BinaryParameters

@webda/aws

Class: S3BinaryParameters

Defined in: aws/src/services/s3binary.service.ts:74

S3Binary parameters

Extends​

  • CloudBinaryParameters

Implements​

Constructors​

Constructor​

new S3BinaryParameters(): S3BinaryParameters

Returns​

S3BinaryParameters

Inherited from​

CloudBinaryParameters.constructor

Properties​

_maxFileSize​

protected _maxFileSize: number

Defined in: core/lib/services/binary.service.d.ts:660

max file size

Inherited from​

CloudBinaryParameters._maxFileSize

_maxUploadSize?​

protected optional _maxUploadSize?: number

Defined in: core/lib/services/binary.service.d.ts:661

Inherited from​

CloudBinaryParameters._maxUploadSize

bucket​

bucket: string

Defined in: aws/src/services/s3binary.service.ts:105

Bucket to store the binaries in

CloudFormation?​

optional CloudFormation?: any

Defined in: aws/src/services/s3binary.service.ts:109

CloudFormation customization

CloudFormationSkip?​

optional CloudFormationSkip?: boolean

Defined in: aws/src/services/s3binary.service.ts:113

Skip CloudFormation on deploy

contentStorage?​

optional contentStorage?: object

Defined in: core/lib/services/cloudbinary.d.ts:10

default?​

optional default?: boolean

register?​

optional register?: boolean

Inherited from​

CloudBinaryParameters.contentStorage

credentialProfiles?​

optional credentialProfiles?: Record<string, NonNullable<AWSServiceParameters["credentials"]>>

Defined in: aws/src/services/s3binary.service.ts:90

Named credentials selectable through ?credential=<name> in content URLs.

credentials?​

optional credentials?: object

Defined in: aws/src/services/s3binary.service.ts:84

Static credentials, default to the AWS environment variables

Can be encrypted with webda config encrypt

accessKeyId​

accessKeyId: string | SecretString

secretAccessKey​

secretAccessKey: string | SecretString

sessionToken?​

optional sessionToken?: string | SecretString

Implementation of​

AWSServiceParameters.credentials

endpoint?​

optional endpoint?: string

Defined in: aws/src/services/s3binary.service.ts:78

Custom endpoint (localstack, minio, ...)

Implementation of​

AWSServiceParameters.endpoint

forcePathStyle?​

optional forcePathStyle?: boolean

Defined in: aws/src/services/s3binary.service.ts:101

Use path style url (required by localstack/minio)

Default​

false

models​

models: object

Defined in: core/lib/services/binary.service.d.ts:675

Define the map of models

  • indicates all models

key is a Store name the string[] represent all valids attributes to store files in * indicates all attributes

Index Signature​

[key: string]: string[]

Inherited from​

CloudBinaryParameters.models

pendingTimeout?​

optional pendingTimeout?: number

Defined in: aws/src/services/s3binary.service.ts:118

Seconds a direct upload stays pending before its marker (and its data, when unused) is swept

Default​

86400

prefix?​

optional prefix?: string

Defined in: core/lib/services/cloudbinary.d.ts:9

Inherited from​

CloudBinaryParameters.prefix

region?​

optional region?: string

Defined in: aws/src/services/s3binary.service.ts:95

AWS region

Default​

"us-east-1"

Implementation of​

AWSServiceParameters.region

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

CloudBinaryParameters.type

urlExpiry​

urlExpiry: number

Defined in: core/lib/services/binary.service.d.ts:667

Lifetime in seconds of the signed URLs

Default​

30

Inherited from​

CloudBinaryParameters.urlExpiry

Accessors​

maxFileSize​

Get Signature​

get maxFileSize(): number

Defined in: core/lib/services/binary.service.d.ts:697

Get the max file size in bytes

Returns​

number

the result number

Set Signature​

set maxFileSize(value): void

Defined in: core/lib/services/binary.service.d.ts:683

Define the maximum filesize to accept as direct upload

Default​
10 MB
Parameters​
value​

string | number

Returns​

void

Inherited from​

CloudBinaryParameters.maxFileSize

maxUploadSize​

Get Signature​

get maxUploadSize(): number

Defined in: core/lib/services/binary.service.d.ts:688

Maximum size accepted for a direct-to-bucket upload, undefined means no limit

Returns​

number

the limit in bytes or undefined

Set Signature​

set maxUploadSize(value): void

Defined in: core/lib/services/binary.service.d.ts:692

Maximum size accepted for a direct-to-bucket upload, undefined means no limit

Parameters​
value​

string | number

Returns​

void

Inherited from​

CloudBinaryParameters.maxUploadSize

Methods​

load()​

load(params?): this

Defined in: aws/src/services/s3binary.service.ts:125

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

CloudBinaryParameters.load

update()​

update(params, delta): this

Defined in: core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

CloudBinaryParameters.update

with()​

with(callback): this

Defined in: core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

CloudBinaryParameters.with