Creating an S3 cross-account destination
Intro
You can use an S3 cross account destination to:
- Export query results to an Amazon S3 bucket with cross account authentication.
Important S3 configuration |
You will need to configure your S3 bucket to be able to receive data from InfoSum before you create this destination in the platform. You can find instructions on how to configure it in this article. |
Once a destination is created, saved destinations are available to all users in your company and can be reused indefinitely.
S3 cross-account destination
First, select the Destinations tab under Activate and then click Create a New Destination.
The form below appears when you select S3 Cross Account as your destination type. The following fields need to be completed:
- Destination Type: Select S3 cross account.
- Name: Identifies the destination
- Description: A free-text explanation of the destination
Once completed, press Next.
Adding S3 cross account connection details
Use destinations to create a connection between the InfoSum Platform and your Amazon S3 bucket with cross account authentication
The above form contains the following fields:
Details
Destination Type: S3 Cross Account.
Name: Name of your destination.
Infosum Principal ID: An InfoSum generated ARN. Enter this into your AWS account and replace the text in the Trust Policy as described in Adding details to the destination
Infosum External ID: The External ID will need to be added to the Trust Relationships tab within your AWS policy
S3 connection details
- Bucket: Specify the bucket name (no leading s3 identifier (e.g. "bucket-name" not "s3://bucket-name")
- Region: Select the region from dropdown menu, matching the AWS region the bucket is located.
Credentials to authenticate with:
1. Push Role ARN: Credentials for the ARN (Amazon Resource Name) of the role to assume for export. You need to create a role that has a Permissions Policy that allows writing to the S3 bucket.
The following are the general formats for ARNs. The specific formats depend on the resource.
arn:partition:service:region:account-id:resource-id
arn:partition:service:region:account-id:resource-type/resource-id
arn:partition:service:region:account-id:resource-type:resource-id
Further information can be found here https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
2. Session Name: Name to use for export.
3. Filename: Name the exported file (free text).
Optional Settings:
Destination Path: The name of any target “folder” within the bucket in which to store the data
Click Submit. The saved destination is stored in the Platform’s Destinations page and can be selected in the Activations tab when pushing an activation file to a remote resource. The destination can be reused and is available to all users in your company.
Exporting results to a destination
After creating an activation, you can export activation query results to a preconfigured destination. This allows you to export data to a location without re-entering your destination configuration and security credentials.
You can activate results to a file using either Segment Builder or the Query Tool. Go to the Activation tab under Activate, where you will see some information about the campaign and its status. The total rows give you an insight into the size of the file before pushing it to the destination.
At the bottom of the page, you will see a box providing more details on the campaign, such as the query used and the name of the output column. There are three menu tabs within this box - Details, Export Configuration and Export History.
Once you've exported the results, the details and status will be viewable under the Export History tab.
Switch to Export Configuration and select Destination. Contact your Customer Support Representative contact if the Destination option does not appear.
Select a destination from the list or click Create New to create a new destination.
Depending on the selected destination type, you may need to enter run-time details in the export configuration fields, as described in the tables below.
S3 cross account export configuration fields
Field Name |
Description |
File name |
You can define the filename and file extension ( e.g. pushfile.csv) when exporting a file to an S3 destination. |
Override path |
Optionally, you can override the path specified in the S3 Destination. |
When you have completed the required fields, click Export to Destination. Selecting this button begins the file stream.