> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alumio.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Amazon S3

> Provides access to Amazon S3 cloud storage.

export const FormField = ({property, label, required = false, diType, uiPatterns, children}) => {
  const patterns = Array.isArray(uiPatterns) ? uiPatterns : uiPatterns ? [uiPatterns] : [];
  return <div style={{
    margin: '1.5rem 0'
  }}>
      <div style={{
    display: 'flex',
    alignItems: 'baseline',
    flexWrap: 'wrap',
    gap: '0.5rem',
    marginBottom: '0.25rem'
  }}>
        <strong>{label}</strong>
        <span style={{
    fontSize: '0.7rem',
    fontWeight: 600,
    textTransform: 'uppercase',
    letterSpacing: '0.04em',
    color: required ? '#6241f5' : '#6b7280'
  }}>
          {required ? 'Required' : 'Optional'}
        </span>
      </div>

      <div>{children}</div>

      {diType || patterns.length > 0 ? <p style={{
    fontSize: '0.85rem',
    color: '#6b7280',
    marginBottom: 0
  }}>
          {diType ? <>
              See the <a href={`/references/${diType}`}>{diType}</a> reference.{' '}
            </> : null}
          {patterns.length > 0 ? <>
              Accepts a <a href={`/documentation/placeholders-and-patterns/patterns#${patterns[0]}`}>pattern</a>.
            </> : null}
        </p> : null}
    </div>;
};

Connect Alumio to an Amazon S3 bucket and use it like a filesystem: read files from it and write files to it. Use this whenever a task needs to pick up files from, or drop files into, S3 storage, for example product images, exports, or incoming data feeds. The same connection also works with S3-compatible storage such as DigitalOcean Spaces by setting a custom endpoint.

This documentation describes: [Schema](/schemas/filesystem/aws-s3)

## Fields

### General

<FormField property="key" label="Access key" required>
  The access key identifier created in AWS that Alumio uses to sign in to your S3 account.
</FormField>

<FormField property="secret" label="Secret access key" required>
  The secret that pairs with the access key above. Keep this confidential. Together the two values let Alumio authenticate with AWS.
</FormField>

<FormField property="region" label="AWS Region" required>
  The AWS region your bucket lives in, for example `us-east-1` or `eu-west-1`. It must match the bucket's region, otherwise the connection will fail.
</FormField>

<FormField property="bucket" label="Bucket" required>
  The name of the S3 bucket Alumio reads from and writes to.
</FormField>

### Advanced

<FormField property="prefix" label="Path prefix">
  Restricts the connection to a folder inside the bucket. When set, every read and write is relative to this prefix, so you do not have to repeat it in each path. For example, set `products/images` to work only within that folder. Leave empty to use the whole bucket.
</FormField>

<FormField property="endpoint" label="Endpoint">
  A custom S3 endpoint, used for S3-compatible storage providers such as DigitalOcean Spaces. Leave empty for standard AWS S3, which then uses the regional endpoint automatically (for example `https://s3.eu-west-1.amazonaws.com`).
</FormField>

<FormField property="logger" label="Logger" diType="filesystem-logger">
  Selects how file activity on this connection is recorded, so you can trace which files were read or written.
</FormField>

## Sample data

A connection to a bucket named `acme-exports`, scoped to the `orders` folder, in the `eu-west-1` region.

| Field             | Value             |
| ----------------- | ----------------- |
| Access key        | `your-access-key` |
| Secret access key | `your-secret-key` |
| AWS Region        | `eu-west-1`       |
| Bucket            | `acme-exports`    |
| Path prefix       | `orders`          |

With this configuration, a task that writes `2026-06-10.csv` stores the file at `orders/2026-06-10.csv` inside the `acme-exports` bucket.

```json Configuration theme={null}
{
  "prototype": "aws-s3",
  "parameters": {
    "key": "your-access-key",
    "secret": "your-secret-key",
    "region": "eu-west-1",
    "bucket": "acme-exports",
    "prefix": "orders"
  }
}
```