Skip to main content

AWS S3 storage integration

Connect your AWS S3 storage bucket to Squid​

To access your AWS S3 storage bucket through Squid, first add the integration to Squid in the console.

  • In the Squid Console, navigate to the Integrations page and select the AWS S3 integration.

  • Provide the following details:

    • Integration ID - Choose an ID that is brief and helps identify the integration.
    • Bucket name - The name of the S3 bucket to connect.
    • Region - The region in which the bucket is located.
    • Access key - Your AWS access key. To learn more about access keys, view the AWS docs.
    • Secret key - Your AWS secret. This is securely stored in Squid Secrets.

  • Click Test connection to verify the integration information. Once verified, click Add integration.

S3 integration

To access the storage bucket from the client, create a reference to a StorageClient using the storage() method, passing your storage integration ID:

Client code
const topic = squid.storage('YOUR_STORAGE_INTEGRATION_ID');

With this storage instance, you can upload files, read metadata, generate download URLs, and download content. To learn more about managing files from the client, view the Squid storage documentation.