Overview

CleverTap allows you to import and export user and event data to and from an Amazon S3 bucket. This document covers creating an S3 bucket on AWS, adding the bucket to the CleverTap dashboard, and selecting a configuration method. The method-specific steps are covered in separate documents.

With the Amazon S3 integration, you can:

• Import user profiles and events from files stored in your S3 bucket.
• Export profile and event data to your S3 bucket for analysis in BI tools or storage in a data warehouse.
• Encrypt exported data with your own AWS KMS key (SSE-KMS).

Choose Configuration Method

CleverTap supports three methods to grant access to your S3 bucket. Select one before you begin.

Prerequisites

Ensure the following before you begin:

• An active AWS account with permissions to create S3 buckets. Depending on your method, you also need permissions to create IAM policies and users (Access Key) or KMS keys (SSE-KMS).
• A CleverTap account with the Amazon S3 partner enabled.
• A globally unique bucket name. Refer to the bucket naming rules in Create S3 Bucket on AWS.

Set Up Amazon S3 Bucket with CleverTap

The following are the major steps to add an Amazon S3 bucket:

1. Create S3 Bucket on AWS​.
2. Add Bucket on CleverTap Dashboard​.
3. Verify Connection​.

Create S3 Bucket on AWS

This section covers how to create a general-purpose S3 bucket.

If you are using IAM Policy with SSE-KMS Encryption, complete steps 1 to 8, create a KMS key as described in IAM Policy with SSE-KMS Encryption, and then complete steps 9 and 10.

To create an S3 bucket, perform the following steps:

1. Log in to the AWS console and search for S3 in the search bar.

2. Select S3 from the search results.

   

3. Click Create bucket.

4. Under General configuration, verify that the AWS Region matches the region you will select on the CleverTap dashboard. AWS pre-selects the region based on your current console region. If the regions do not match, the export connection cannot be saved.

   

5. Under Bucket name, enter a name for the bucket. You must enter the same name in the Folder field on the CleverTap dashboard.

   📘

   Note

   Bucket names must be 3 to 63 characters, begin and end with a letter or number, and contain only lowercase letters, numbers, periods (.), and hyphens (-). Bucket names must be unique across all AWS accounts.

   

6. Under Object Ownership, CleverTap recommends selecting ACLs disabled.

   

7. Under Block Public Access settings for this bucket, select Block all public access.

   

8. Under Bucket Versioning, select Disable.

   

9. Under Default encryption, select the encryption type that matches your configuration method:

   • Access Key or IAM Role: Keep the default selection of Server-side encryption with Amazon S3 managed keys (SSE-S3).

   • IAM Policy with SSE-KMS Encryption: Select Server-side encryption with AWS Key Management Service keys (SSE-KMS) and paste the KMS key ARN that you copied in Create KMS Key on AWS into the AWS KMS key ARN field.

     📘

     Note

     The integration works with the default settings. Check your organization's internal policies to determine whether any setting requires a change.

10. Click Create bucket.

Add Bucket on CleverTap Dashboard

This section covers how to enter the bucket details on the CleverTap dashboard. The details you enter here (in particular, Folder) are used to generate the policies for the IAM Role and SSE-KMS methods, so complete this section before the AWS policy steps.

To add the bucket, perform the following steps:

1. On the CleverTap dashboard, go to Settings > Partners and select Amazon S3 on the Integrations tab.

   

2. Select the connection type:

   1. For import, select the Import Connections tab.
   2. For export, select the Export Connections tab.

3. Click Add Amazon S3 Bucket, then add the bucket details.

   

4. Under Configure with, select one of the following methods and refer to the corresponding document to complete the configuration:

   • Access Key
   • IAM Role
   • IAM Policy with SSE-KMS Encryption

Verify Connection

After you complete the steps on AWS, return to the CleverTap dashboard.

• Import: Click Test Connection. CleverTap checks access by listing the bucket (and the subfolder, if specified) using the configured method. When the test succeeds, click Save.
• Export: Click Save. CleverTap uploads a test file to the bucket and region you specified. The connection is saved only if the upload succeeds.

If the test or save fails, refer to Troubleshooting.

Troubleshooting

FAQs

What permission does CleverTap need?

For import, CleverTap needs read access (s3:GetObject, s3:ListBucket) on the bucket. For export, CleverTap needs write access (s3:PutObject) on the bucket path. The IAM Role and SSE-KMS methods generate the exact policy for you.

Can I use one connection for both import and export?

No. Import and export connections are configured separately under Import Connections and Export Connections. You can point both at the same bucket.

Does the bucket have to be in the same region as my CleverTap account?

No. Any AWS region works.

Next Steps

After you configure the connection, you can create imports and exports that use it.

• Create an import that reads from this connection. For more information, refer to Create Import, Map Data for Import, Schedule Import, and Import Listing and Stats.
• Create an export that writes to this connection. For more information, refer to Cloud Storage, Event Exports, or Profile Exports.