AWS S3 Setup Guide

Follow our setup guide to connect your AWS S3 bucket to Fivetran.

Prerequisiteslink

To connect your AWS S3 bucket to Fivetran, you need:

• An S3 bucket containing files with supported file types and encodings
• For private or encrypted buckets, an AWS account with the ability to grant Fivetran permission and to read from the bucket

Setup instructionslink

To authorize Fivetran to connect to your S3 bucket, follow these instructions:

NOTE: If you are syncing from a public bucket, skip ahead to finish Fivetran configuration. You don’t need an AWS account to sync from public buckets.

Get your External IDlink

In the connector setup form, find the automatically-generated External ID and make a note of it. You will need it to create an IAM role in AWS.

NOTE: The automatically-generated External ID is tied to your account. If you close and re-open the setup form, the ID will remain the same. You may wish to keep the tab open in the background while you configure your source for convenience, but closing it is also OK.

Create an IAM Policy for Fivetranlink

This step will allow Fivetran to access your S3 bucket.

1. Open your Amazon IAM console.

2. Go to Policies, then select Create Policy.

   

3. Go to the JSON tab.

   

4. Copy the following policy and paste it in the JSON tab, replacing {your-bucket-name} with the name of your S3 bucket.

   {
   "Version": "2012-10-17",
   "Statement": [
       {
         "Effect": "Allow",
         "Action": [
   "s3:Get*",
   "s3:List*"
         ],
         "Resource": "arn:aws:s3:::{your-bucket-name}/*"
       },
       {
         "Effect": "Allow",
         "Action": [
   "s3:Get*",
   "s3:List*"
         ],
         "Resource": "arn:aws:s3:::{your-bucket-name}"
       }
     ]
   }
   

5. For encrypted buckets, follow Amazon’s AWS S3 bucket instructions to modify the AWS KMS key’s policy to grant Fivetran permissions to download files from your encrypted bucket.

6. Click Review Policy.

   

7. Name the policy “Fivetran-S3-Access”.

   

8. Click Create Policy.

Create an IAM role for Fivetranlink

1. Go to Roles, then select Create New Role.

   

2. Select Another AWS Account, then enter Fivetran’s account ID, 834469178297, in the Account ID field.

   

3. Select the Require external ID checkbox.

4. Enter the External ID you found in your connector setup form.

   

5. Click Next: Permissions.

6. Select the “Fivetran-S3-Access” policy that you created in Step 2.

   

7. Click Next: Tags, which is optional.

8. Click Next: Review.

9. Name your new role “Fivetran”, then click Create Role.

   

10. Select the Fivetran role you just created.

    

11. Find the Role ARN and make a note of it. You will need it to fill in your connector setup form.

    

Permissions (Optional)link

You can specify permissions for the Role ARN that you designate for Fivetran. Giving selective permissions to this Role will allow Fivetran to only sync what it has permissions to see.

Finish Fivetran configuration link

1. In the connector setup form, enter your chosen destination schema name.

2. Enter your chosen destination table name.

3. Enter your S3 bucket.

4. If you are syncing from a private bucket, enter the Role ARN you found in AWS.

5. (Optional) Specify a folder path. This folder path is used to specify a portion of the bucket in which you’d like Fivetran to look for files. Any files under the specified folder and all of its nested subfolders will be examined for files we can upload. If no prefix is supplied, we’ll look through the entire bucket for files to sync.

6. (Optional) Specify a file pattern. The file pattern is a regular expression that we use to decide whether or not to sync certain files. It applies to everything under the prefix. For instance, suppose under the prefix logs you had three folders: 2017, 2016, and errors. Using the pattern \d\d\d\d/.*, you could exclude all the files in the errors folder, because \d\d\d\d only applies to the folders whose name consists of four consecutive digits, and because .* after / applies to any files in these folders. If you’re not sure what regular expression to use, you can leave this field blank, and we’ll sync everything under the prefix. If you’re feeling particularly bold, you can learn to write your own regex here and test it out using this tool.

7. Select a file type. The file type is used to let Fivetran know that even files without a file extension ought to be parsed as this file type. For example, if you have an automated CSV output system that saves files without a .csv extension, you can specify the CSV type and we will sync them correctly as CSVs. Selecting “infer” will let Fivetran infer from a file’s extension (.csv, .tsv, .json, .avro, or .log) what to sync. If you do choose a file type, every file we examine will be interpreted as the file type you select, so make sure everything Fivetran syncs has the same file type.

8. Select a compression format. The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. For example, if you have an automated CSV output system that GZIPs files to save space, but saves them without a .gzip extension, you can set this field to GZIP. The integration will then decompress every file that it examines using GZIP. If all of your compressed files are correctly marked with a matching compression extension (.bz2, .gz, .gzip, .tar, or .zip), you can select “infer”.

9. Choose an error handling option. Selecting skip ignores any improperly formatted data within a file, allowing you to sync only valid data. Choosing fail enables you to prevent a file from syncing if any improperly formatted data is detected. With either option you will receive a notification on your dashboard if errors are encountered.

10. (Optional) If you’d like, you can set the Show Advanced Options toggle to ON. Note that these options are for advanced configuration, and are only necessary in highly specific cases.

    • Select a modified file merge option. When a previously synced file is modified, should the rows in the destination be replaced or should the new rows be appended to the table. upsert_file option will replace records in destination, using the filename and line number as the primary key. append_file option will append records.
    • (Optional) Enter an archive folder pattern. If there are multiple files within archive (TAR or ZIP) folders, you can use the archive folder pattern to filter those as well. For example, the archive folder pattern .*json will sync from an archive folder only those files that end in a .json file extension.
    • (Optional) Enter a null sequence. CSVs have no native notion of a null character. However, some CSV generators have created one, using characters such as \N to represent null. Note: text is un-escaped before the null sequence is matched, so don’t use the escape character in your null sequence. Only use this field if you are sure your CSVs have a null sequence.
    • (Optional) Enter a delimeter. The delimiter is a character used in CSV files to separate one field from the next. If this is left blank, Fivetran will infer the delimiter for each file, and files of many different types of delimiters can be stored in the same folder with no problems. If this is not left blank, then all CSV files in your search path will be parsed with this delimiter.
    • (Optional) Enter an escape character. CSVs have a special rule for escaping quotation marks as opposed to other characters - they require two consecutive double quotes to represent an escaped double quote. However, some CSV generators do not follow this rule and use other characters like backslash for escaping. Only use this field if you are sure your CSVs have a different escape character.
    • (Optional) Choose to skip header and/or footer lines.
    • (Optional) Select a listing strategy. The default option is complete_listing, where we list all the new and modified files from the bucket. The second option is time_based_pattern_listing. If you add new files in lexicographic order to the bucket, in each sync, we will try to identify a time-based pattern and only list and sync the files that are lexicographically greater than the last file synced in the previous sync. If we are unable to identify a time-based pattern, we will use the default option. For more information, see our documentation.

11. Click Save & Test. Fivetran will take it from here and sync your data from your AWS S3 bucket.

Related Contentlink

description Connector Overview

assignment Release Notes

settings API Connector Configuration

home Documentation Home