MongoDB Stitch Server SDK
Options
All
  • Public
  • Public/Protected
  • All
Menu

AwsS3ServiceClient

The AWS S3 service client.

Index

Variables

Methods

Variables

Const factory

factory: NamedServiceClientFactory<AwsS3ServiceClient> = new class implements NamedServiceClientFactory<AwsS3ServiceClient> {public getNamedClient(service: CoreStitchServiceClient,client: StitchAppClientInfo): AwsS3ServiceClient {return new AwsS3ServiceClientImpl(new CoreAwsS3ServiceClient(service));}}()

Methods

putObject

  • putObject(bucket: string, key: string, acl: string, contentType: string, body: string | BSON.Binary | Uint8Array | ArrayBuffer | Buffer): Promise<AwsS3PutObjectResult>

  • Puts an object.

    Parameters

    • bucket: string

      the bucket to put the object in.

    • key: string

      the key (or name) of the object.

    • acl: string

      the ACL to apply to the object (e.g. private).

    • contentType: string

      the content type of the object (e.g. application/json).

    • body: string | BSON.Binary | Uint8Array | ArrayBuffer | Buffer

      the body of the object.

    Returns Promise<AwsS3PutObjectResult>

    a Promise containing the result of the put, which contains the location of the object.

signPolicy

  • signPolicy(bucket: string, key: string, acl: string, contentType: string): Promise<AwsS3SignPolicyResult>

  • Signs an AWS S3 security policy for a future put object request. This future request would be made outside of the Stitch SDK. This is typically used for large requests that are better sent directly to AWS.

    See Also

    Uploading a File to Amazon S3 Using HTTP POST

    Parameters

    • bucket: string

      the bucket to put the future object in.

    • key: string

      the key (or name) of the future object.

    • acl: string

      the ACL to apply to the future object (e.g. private).

    • contentType: string

      the content type of the object (e.g. application/json).

    Returns Promise<AwsS3SignPolicyResult>

    a Promise containing the signed policy details.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc