Guide

Amazon S3 Endpoint

Source

Amazon S3 endpoints connect Gateway to S3-compatible object storage for governed bucket and object operations.

Endpoint Kind

Use s3 as the endpoint kind when creating this endpoint through the API or dashboard.

What Gateway Uses This Endpoint For

  • List, read, and manage object-storage data through approved tools.
  • Use object storage in migration, analytics, and document-processing workflows.
  • Centralize S3 credential handling.
  • Support custom endpoints such as LocalStack or compatible object stores.

Basic Endpoint Shape

json
{
  "endpoint": "s3-data",
  "kind": "s3",
  "config": {
    "read_conn": {
      "provider": "AwsS3",
      "region": "us-east-1",
      "default_bucket": "analytics-data",
      "access_key_id": "AKIA...",
      "secret_access_key": "secret"
    }
  }
}

Create it with the endpoint API:

bash
curl -sS -X POST "$EDEN/endpoints" \
  -H "$AUTH_HEADER" \
  -H "Content-Type: application/json" \
  -d '{
  "endpoint": "s3-data",
  "kind": "s3",
  "config": {
    "read_conn": {
      "provider": "AwsS3",
      "region": "us-east-1",
      "default_bucket": "analytics-data",
      "access_key_id": "AKIA...",
      "secret_access_key": "secret"
    }
  }
}'

Configuration Fields

FieldPurpose
regionAWS region
access_key_idAccess key ID
secret_access_keySecret access key
session_tokenOptional session token
default_bucketOptional default bucket
endpoint_urlOptional custom endpoint URL

Operating Notes

  • Use bucket policies and IAM to restrict object prefixes before exposing access through Gateway.
  • Avoid broad write/delete permissions unless the workflow requires them.
  • Treat object contents as potentially sensitive and gate reads through RBAC.
Help improve Eden Docs

Find something unclear or incomplete? Review the source and propose an update.

View on GitLab Updated August 2, 2026