Prerequisites
- By default, Athena authentication uses role-based access. You will need the trust policy prepopulated with our identifier to grant access. It should look similar to the following JSON object with a proper service account identifier:
Trust policy
Trust policies for AWS deploymentsIf you are running Prequel on a self-hosted AWS deployment, the Trust Policy JSON will reference an AWS federation account instead of the Google Cloud federation service seen in the above JSON document.
Create a staging bucket, service policy, and role
- Role-based access (recommended)
- HMAC Access Key ID & Secret Access Key
Create Athena staging bucket
Follow these steps to create a bucket to be used for staging data before transferring to a destination.- Navigate to the S3 service page.
- Click Create bucket.
- Enter a Bucket name, select the same AWS Region as your Athena S3 source, and modify any of the default settings as desired. Note: Object Ownership can be set to “ACLs disabled” and Block Public Access settings for this bucket can be set to “Block all public access” as recommended by AWS. Make note of the Bucket name and AWS Region.
- Click Create bucket.
Create Athena access policy
- Navigate to the IAM service page, click on the Policies navigation tab, and click Create policy.
- Click the JSON tab, and paste the following policy, being sure to replace
ACCOUNT_ID,WORKGROUP,BUCKET_SOURCEandBUCKET_STAGINGwith the your account information.WORKGROUPshould beprimaryunless otherwise specified during connection configuration.BUCKET_SOURCEshould refer to the bucket(s) containing the underlying data to be queried by Athena.BUCKET_STAGINGshould refer to the staging bucket created in the previous step. Note: astagingfolder is created automatically in the provided staging bucket to temporarily “stage” query results before transferring to destinations.
Access policy
KMS encryption (optional)If your S3 source or staging buckets use KMS encryption (CMK), add the following statement to the Replace
Statement array of your IAM policy to allow data encryption/decryption with your KMS key. Encryption with SSE-C is not currently supported.KMS statement
REGION_NAME, ACCOUNT_ID, and KEY_ID with your values.Athena vs. S3 permissionsBecause Athena uses S3 as a data source, the Resource access requested in the policy are scoped down via resource-specific permissions in the S3 actions.
BUCKET_SOURCE vs. BUCKET_STAGINGDuring source configuration, you will notice both a BUCKET_SOURCE and a BUCKET_STAGING. They are used for two different purposes here:BUCKET_SOURCEshould be the name of the S3 bucket in which the source data is located. Permissions on this resource are limited to read-only operations.BUCKET_STAGINGshould be the name of the S3 bucket in which the Athena query results are written (i.e., the automatically generatedathena_output/data).
- Click through to the Review step, choose a name for the policy, for example,
transfer-service-policy(this will be referenced in the next step), add a description, and click Create policy.
Create role
- Navigate to the IAM service page.
- Navigate to the Roles navigation tab, and click Create role.
- Select Custom trust policy and paste the provided trust policy (referenced in the prerequisite at the top of this guide) to allow AssumeRole access to this role. Click Next.
- Add the permissions policy created above, and click Next.
- Enter a Role name, for example,
transfer-role, and click Create role. - Once successfully created, search for the created role in the Roles list, click the role name, and make a note of the ARN value.
Add source to Prequel
Test the connection & add the configured source to Prequel in the Prequel UI or via cURL request.