Skip to main content

External S3 Connections

You can create connections to specific S3 buckets in Alteryx Analytics Cloud (AAC).These connections to S3 enable workspace users to connect to specific S3 buckets.

Simple Storage Service (S3)is an online data storage service provided by Amazon, which provides low-latency access through web services. For more information, see https://aws.amazon.com/s3/.

  • Read: Supported

  • Write: Supported

Prerequisites

Before you begin, please verify that your AAC environment meets the following requirements:

  • Integration: Your AAC instance is connected to a running environment supported by your product edition.

  • Multiple region: Multiple S3 connections can be configured in different regions.

  • Verify that Enable S3 Connectivity has been enabled in the Workspace Settings Page.

  • Acquire the Access Key ID and Secret Key for the S3 bucket or buckets to which you are connecting. For more information on acquiring your key/secret combination, contact your S3 administrator.

Permissions

Access to S3 requires:

  • Each user must have appropriate permissions to access S3.

  • To browse multiple buckets through a single S3 connection, additional permissions are required. See below.

Limitations

  • Authentication using IAM roles is not supported.

  • Automatic region detection in the create and edit connection is not supported.

Create Connection

You can create additional S3 connections by the following method:

Create through application

You can create a S3 connection through the application.

Steps:

  1. Login to the application.

  2. In the left navigation bar, click the Connections icon.

  3. In the Create Connection page, click the External Amazon S3 card.

  4. Specify the connection properties:

    Property

    Description

    DefaultBucket

    (Optional) The default S3 bucket to which to connect. When the connection is first accessed for browsing, the contents of this bucket are displayed.

    If this value is not provided, then the list of available buckets based on the key/secret combination is displayed when browsing through the connection.

    Note

    To see the list of available buckets, the connecting user must have the getBucketList permission. If that permission is not present and no default bucket is listed, then the user cannot browse S3.

    When creating an external S3 connection, you can specify a default directory path within your default S3 bucket. By setting a default directory, you will be directed to this directory by default when browsing the connection.

    Access Key ID

    Access Key ID for the S3 connection.

    Secret Key

    Secret Key for the S3 connection.

    Server Side Encryption

    If server-side encryption has been enabled on your bucket, you can select the server-side encryption policy to use when writing to the bucket. SSE-S3 and SSE-KMS methods are supported. For more information, see http://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html.

    Server Side Kms key Id

    When KMS encryption is enabled, you must specify the AWS KMS key ID to use for the server-side encryption. For more information, see "Server Side KMS Key Identifier" below.

    For more information on the other options, see Create Connection Window.

  5. Click Save.

Server Side KMS Key Identifier

When KMS encryption is enabled, you must specify the AWS KMS key ID to use for the server-side encryption.

The format for referencing this key is the following:

"arn:aws:kms:<regionId>:<acctId>:key/<keyId>"

You can use an AWS alias in the following formats. The format of the AWS-managed alias is the following:

"alias/aws/s3"

The format for a custom alias is the following:

"alias/<FSR>"

where:

<FSR> is the name of the alias for the entire key.

Create via API

For more information on the vendor and type information to use, see Connection Types.

For more information, see Coming soon.

Java VFS Service

The Java VFS Service has been modified to handle an optional connection ID, enabling S3 URLs with connection ID and credentials. The other connection details are fetched in AAC to create the required URL and configuration.

// sample URI
s3://bucket-name/path/to/object?connectionId=136


// sample java-vfs-service CURL request with s3
curl -H 'x-trifacta-person-workspace-id: 1' -X GET 'http://localhost:41917/vfsList?uri=s3://bucket-name/path/to/object?connectionId=136'

Using S3 Connections

Uses of S3

AAC can use S3 for the following tasks:

  • Enabled S3 Integration: AAC has been configured to integrate with your S3 instance.

  • Creating Datasets from S3 Files: You can read in source data stored in S3. An imported dataset may be a single S3 file or a folder of identically structured files. See Reading from Sources in S3 below.

  • Reading Datasets: When creating a dataset, you can pull your data from a source in S3. See Creating Datasets below.

In AAC, S3 is accessed through the S3 browser. See S3 Browser.

Note

When AAC executes a job on a dataset, the source data is untouched. Results are written to a new location, so that no data is disturbed by the process.

Before you begin using S3

  • Access: If you are using system-wide permissions, your administrator must configure access parameters for S3 locations. If you are using per-user permissions, this requirement does not apply.

    Warning

    Avoid using /trifacta/uploads for reading and writing data. This directory is used by AAC.

Secure access

Your administrator can grant access on a per-user basis or for the entire workspace.

AAC utilizes an S3 key and secret to access your S3 instance. These keys must enable access to the appropriate directories in the S3 instance.

Note

If you disable or revoke your S3 access key, you must update the S3 keys for each user or for the entire system.

Storing data in S3

Your administrator should provide raw data or locations and access for storing raw data within S3. All AAC users should have a clear understanding of the folder structure within S3 for each individual.

  • Users should know where shared data is located and where personal data is stored without interfering with or confusing other users.

  • AAC stores the results of each job in a separate folder in S3.

Note

AAC does not modify source data in S3. Source data stored in S3 is read without modification from source locations, and source data uploaded to AAC is stored in /trifacta/uploads.

Reading from sources in S3

You can create an imported dataset from one or more files stored in S3.

Note

Import of glaciered objects is not supported.

Wildcards:

You can parameterize your input paths to import source files as part of the same imported dataset.

Folder Selection:

When you select a folder in S3 to create your dataset, you select all files in the folder to be included.

Notes:

  • This option selects all files in all sub-folders and bundles them into a single dataset. If your sub-folders contain separate datasets, you should be more specific in your folder selection.

  • All files used in a single imported dataset must be of the same format and have the same structure. For example, you cannot mix and match CSV and JSON files if you are reading from a single directory.

When a folder is selected from S3, the following file types are ignored:

  • *_SUCCESS and *_FAILED files, which may be present if the folder has been populated by the running environment.

Note

If you have a folder and file with the same name in S3, search only retrieves the file. You can still navigate to locate the folder.

Creating Datasets

When creating a dataset, you can choose to read data in from a source stored from S3 or local file.

  • S3 sources are not moved or changed.

  • Local file sources are uploaded to /trifacta/uploads where they remain and are not changed.

Data may be individual files or all of the files in a folder. In the Import Data page, click the S3 tab. See Import Data Page.

In this section: