Skip to main content

@webda/aws • Readme | API

Class: S3BinaryParameters

Extends​

  • AWSServiceParametersMixin<typeof BinaryParameters, this> & BinaryParameters<this>

Constructors​

new S3BinaryParameters(params, service)​

new S3BinaryParameters(params, service): S3BinaryParameters

Parameters​

• params: any

• service: S3Binary<S3BinaryParameters>

Returns​

S3BinaryParameters

Overrides​

AWSServiceParameters(BinaryParameters).constructor

Source​

packages/aws/src/services/s3binary.ts:27

Properties​

CloudFormation​

CloudFormation: any

Source​

packages/aws/src/services/s3binary.ts:24

CloudFormationSkip​

CloudFormationSkip: boolean

Source​

packages/aws/src/services/s3binary.ts:25

bucket​

bucket: string

Source​

packages/aws/src/services/s3binary.ts:22

credentials?​

credentials?: Object

Type declaration​

accessKeyId​

accessKeyId: string

secretAccessKey​

secretAccessKey: string

sessionToken?​

sessionToken?: string

Inherited from​

AWSServiceParameters(BinaryParameters).credentials

Source​

packages/aws/src/services/aws-mixin.ts:24

endpoint?​

endpoint?: string

Inherited from​

AWSServiceParameters(BinaryParameters).endpoint

Source​

packages/aws/src/services/aws-mixin.ts:23

expose?​

expose?: Object

Expose the service to http

Deprecated​

will be removed in 4.0

Type declaration​

restrict?​

restrict?: Object

Restrict some APIs

restrict.create?​

restrict.create?: boolean

Restrict POST

restrict.delete?​

restrict.delete?: boolean

Restrict DELETE

restrict.get?​

restrict.get?: boolean

Restrict GET

restrict.metadata?​

restrict.metadata?: boolean

Restrict update of metadata

url​

url: string

URL to expose the service to

Inherited from​

AWSServiceParameters(BinaryParameters).expose

Source​

packages/core/lib/services/binary.d.ts:300

forcePathStyle?​

forcePathStyle?: boolean

Source​

packages/aws/src/services/s3binary.ts:21

map​

map: Object

Define the map to Object collection

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

Deprecated​

Index signature​

[key: string]: string[]

Inherited from​

AWSServiceParameters(BinaryParameters).map

Source​

packages/core/lib/services/binary.d.ts:283

models​

models: Object

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​

AWSServiceParameters(BinaryParameters).models

Source​

packages/core/lib/services/binary.d.ts:293

openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

AWSServiceParameters(BinaryParameters).openapi

Source​

packages/core/lib/services/service.d.ts:104

prefix?​

prefix?: string

Source​

packages/aws/src/services/s3binary.ts:23

region?​

region?: string

Inherited from​

AWSServiceParameters(BinaryParameters).region

Source​

packages/aws/src/services/aws-mixin.ts:29

type​

type: string

Type of the service

Inherited from​

AWSServiceParameters(BinaryParameters).type

Source​

packages/core/lib/services/service.d.ts:95

url?​

url?: string

URL on which to serve the content

Inherited from​

AWSServiceParameters(BinaryParameters).url

Source​

packages/core/lib/services/service.d.ts:99