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 panel
- 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.
- 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 - Session Name: Name to use for export.
- 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
-
Overwrite Existing Object (toggle):
- Toggling this on allows you to export files with the same name and overwrite the existing files.
- If this toggle is off, exports of files with the same name will fail as a file already exists with that name, so we recommend keeping the Filename setting as 'editable during export' and changing the name before exporting
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
You can activate results to a Destination using either Segment Builder or the Query Tool.
- Navigate to Activation Segments & start an export
Once you’ve created the activation segment, go to the Activation Segments tab under Activate, where you can find all of the historic segments that have been created by your team for that collaboration. Please ensure you are in the correct Collaboration view at the top for the Activation you're looking for.
A ‘ready’ status shows that the query has been successful and is ready to be sent to a Destination. Activation segments are only ‘Ready’ for 36 hours, this is to ensure that you are always exporting the freshest data. You can easily refresh a segment by clicking ‘refresh’ in the details panel of each segment.
When you select an Activation segment, an information panel appears on the side of the page allowing you to view the segment and export it to a Destination with the correct permissions for that Collaboration.
You can click ‘Export’ to start a new export, or click ‘View’ / double-click on the activation segment name to view all exports associated with this segment.
2. Select your destination
After you click Export, a new pane will appear with a list of the destinations available for this segment. You will be able to see all the Destinations that your company owns or has permission to use for that Collaboration. Select your destination, and configure any custom fields.
3. Configure the export
When you select the correct Destination, the pop up will show additional options, including column mapping if required and optional fields.
4. Click Export to Destination to initiate the activation.