Amazon S3

Prerequisites

1. Admin access to your AWS Console to create/configure an S3 bucket and permissions

Setup Guide

Step 1 - Create an S3 bucket (skip if you already have one you want to use)

1. Login to your AWS Console and switch to the desired region. We recommend choosing the same region you have the rest of your compute/storage/databases (Redshift, Postgres, EC2, EKS, etc).

2. Go to the S3 home page, and click "Create bucket":

3. Select a name for your bucket and keep ACLs disabled

4. You can use the default values for the rest of the settings, or change them to your liking.

Step 2 - Create a policy that grants access to the bucket

1. In your AWS Console, go to IAM. In the menu on the left, click Policies.

2. Click Create Policy and click the JSON tab.

3. Copy the following policy (replace YOUR_S3_BUCKET_NAME with the real bucket name):

{
    "Version": "2012-10-17",
    "Id": "",
    "Statement": [
        {
            "Sid": "ExtractBucketAccess",
            "Effect": "Allow",
            "Action":
            [
                "s3:GetObject",
                "s3:PutObject",
                "s3:ListBucket",
                "s3:GetBucketLocation",
                "s3:DeleteObject"
            ],
            "Resource":
            [
                "arn:aws:s3:::YOUR_S3_BUCKET_NAME",
                "arn:aws:s3:::YOUR_S3_BUCKET_NAME/*"
            ]
        }
    ]
}

4. Click Next, set a Policy name and click Create policy

Step 3 - Choose an authentication mode

There are two methods of authentication:

1. The "Cross Account Role" (Step 4) method is prefered and recommended by AWS. It works by us "assuming" a Role you create in your AWS account.
2. The "Access Key" (Step 5) method works by creating an IAM User with access to the AWS resource, and granting us the Access Key ID and Secret Access Key parameters.

Step 4 - Cross Account Role (Auth Method 1 - Preferred)

1. In the setup tab of your connector, select the "Cross Accont Role" method, and copy the External ID value

2. In your AWS Console, go to IAM. In the menu on the left, click Roles.

3. Click Create role

4. Choose AWS account

5. Select the "Another AWS account" option, and type in this Account ID: 623184213151

6. In Options - enable Require external ID and paste the External ID provided to you in the Setup tab of the connector

7. Find the permission policy you created in Step 2 and select it

8. Give the role a meaningful name and click Create role. For reference your Trust policy should look like this:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "sts:AssumeRole",
            "Principal": {
                "AWS": "623184213151"
            },
            "Condition": {
                "StringEquals": {
                    "sts:ExternalId": "YOUR-EXTERNAL-ID-HERE"
                }
            }
        }
    ]
}

Step 5 - Access Key (Auth Method 2)

1. In the setup tab of your connector, select the "Access Key" method

2

Configuration

Provide the connector configuration in your source definition. The S3 connector reads objects from a bucket using a key_template that can point to:

• A single, exact object key

• A prefix (to read multiple objects under a “folder”)

• A date-partitioned layout (to read objects whose keys include date placeholders)

• bucket
  The S3 bucket name.

• key_template
  The object key, prefix, or template used to locate files in the bucket.

  Supported placeholders:

  • {stream_name} — replaced with the stream name
  • {connection_id} — replaced with the numeric connection id
  • Date placeholders — used to match files across a date range (see below)
  • {extension} — replaced with the file extension for the selected output format (for example, jsonl, csv, parquet)

  Static keys / prefixes (no date placeholders)
  If key_template contains no date placeholders, the connector treats it as “static”:

  • If it resolves to an exact key that exists, that single object is read.
  • Otherwise, it is treated as a prefix and all objects under that prefix are listed and read.
  • If the template still contains unresolved placeholders (for example, {extension}), the connector lists using the portion of the key before the first { as the prefix.

  Examples:

  bucket: my-bucket
  key_template: exports/{stream_name}.jsonl

  bucket: my-bucket
  key_template: exports/{stream_name}/

  Date-partitioned templates
  If key_template includes any date placeholders, the connector lists objects using the portion of the template before the first date placeholder as the S3 listing prefix, then filters the results to the requested date range.

  Example:

  bucket: my-bucket
  key_template: exports/{stream_name}/dt={YYYY}-{MM}-{DD}/data.{extension}

Optional

• output_format
  The expected file format for objects matched by key_template.

• compress
  Whether the matched objects are compressed.

Notes

• If your key_template does not include any date placeholders, the connector treats it as a static key:

  • It first resolves {stream_name} and {connection_id}.
  • If the resolved value still contains unresolved placeholders (for example, {extension}), the connector treats everything before the first { as a prefix and lists all objects under that prefix.
  • Otherwise, it checks for an exact object match at s3://<bucket>/<resolved_key>. If no exact object exists, it falls back to listing objects using the resolved key as a prefix.

• If your key_template does include date placeholders, the connector lists objects using the portion of the template before the first date placeholder as the S3 prefix, then filters the results to the requested date range.