Connect to Amazon S3

Important Nexla Help Center Update:

Nexla's Zendesk Help Center pages are being deprecated and will soon no longer be available.

Nexla Documentation is now the home for Nexla's User Guides, with improved formatting and categories that are easier to navigate, providing a better overall user experience.

Please update any bookmarks to the new Nexla Documentation site (docs.nexla.com/user-guides).

_______________________________________________

This article describes how to add an Amazon S3 data source in Nexla.

Contents:

1. Begin Adding an Amazon S3 Data Source
2. Input Your Credential
3. Connect to the Desired Folder(s)
4. Confirmation

1. Begin Adding an Amazon S3 Data Source

1. Log into Nexla with your provided credentials.
   

   If you need credentials, contact [e-mail].

2. Navigate to the Integrate section by selecting  from the platform menu on the left side of the screen. 
   
   
3. Click  at the top of the Integrate toolbar on the left.
   
   
   
   
4. Select , and click  in the upper right corner of the screen to begin adding an Amazon S3 data source.
   
   

2. Input Your Credential

1. Select "Add A New Credential".
   
   
   
   
2. Enter the name of the credential in the Credential Name field.
   
   
   
   
3. Optional: Enter the desired description of the credential in the Credential Description field.
   
   
4. Select the appropriate API type from the API Type dropdown menu.
   
   
   

   If you don't know the appropriate API type, contact your IT, DevOps, or data engineering team.
   

5. Select the authentication method that should be used with the new source from the Authenticate Using dropdown menu.
   
   
   

   This configures Nexla to access S3 via the selected authentication mechanism—AWS Access with secret keys, IAM ARN, or an IAM instance role.

6. Optional: To configure Nexla to access Amazon S3 using AWS Access with secret keys for authentication
   
   • Enter your AWS access key in the AWS Access Key field.
     
     
     
     
   • Enter your AWS secret key into the AWS Secret Key field.
     
     
     
     
7. Optional: To configure Nexla to access Amazon S3 using IAM ARN for authentication
   
   • Enter the external ID for which Amazon S3 federated access has been configured into the External ID field.
     
     
     
     
8. Optional: Click "Advanced Settings" to access additional options,  which are described in the following steps.
   
   
9. Optional: Enter the IAM Amazon resource name to which the permissions associated with the information entered in Steps 2-7 is applicable in the IAM ARN field using format "arn:partition:service:region:account:resource".
   
   
   
   
10. Optional: Enter the path to which S3 Path List access is limited in the S3 Path List Access is Limited to field using the format "<bucket-name>" or "<bucket-name>/<folder-name>".
    
    
    
    
11. Optional: Check the box next to "Enable Client Side Encryption?" to configure Nexla to decrypt and/or encrypt S3 objects that require client-side encryption using the AWS Key Management System.
    
    
    
    Select the KMS client-side encryption mode that is applicable to the credential entered in Steps 2-7 from the Client Side Encryption Mode dropdown menu.
    
    
    
    Enter the KMS key that Nexla should use to encrypt and/or decrypt objects in the Amazon KMS Key for Encryption field.
    
    

    Ensure that the user whose credentials were entered above has appropriate KMS permissions for the entered key.

    
    
    
    
12. Optional: Check the box next to "Enable Server Side Encryption?" to configure Nexla to encrypt and/or decrypt S3 objects that require server-side encryption.
    
    

    Server-side encryption can be performed using either Amazon S3-managed encryption keys (SSE-S3) or the AWS Key Management Service (SSE-KMS).

    
    
    
    To configure Nexla to perform server-side encryption using the ASW Key Management System, enter the appropriate Key ARN into the Key ARN for SSE with KMS field. To configure Nexla to use Amazon S3-manged encryption keys, leave this field blank.
    
    
    
    
    
13. Optional: Check the box next to "Handle File Encryption/Decryption?" and follow the steps in the Read and Write PGP-Encrypted Files article to configure Nexla such that the source will decrypt files before scanning, and the destination will encrypt the files before uploading to the selected storage.
14. Click .

3. Connect to the Desired Folder(s)

1. To expand a file, click next to it.
   
   
2. To select a file, hover over it, and click the button that appears.
   

   The button should now display .
   

3. Optional: Use the Advanced Settings menu on the right to access additional settings for the source, including file scan scheduling and options related to text files and delimiter-separated values.
   
   
   
   
4. Once all needed files have been selected, click in the upper right corner.

4. Confirmation

1. The confirmation page indicates that the Amazon S3 data source has been successfully added.
   
   
   
   
   
2. Optional: Edit the name of the data source by hovering over it () and entering the desired text.
   
   
3. Optional: Add a description of the data source by hovering over below the source name and entering the desired text.
   
   
4. To return to My Data Sources, click in the upper right corner.
   
   To view the newly created data source, click .
   
   To view Nexsets detected in the newly added source, click .