Skip to content

Commit

Permalink
adding new documentation on supported integrations, and mappings
Browse files Browse the repository at this point in the history
  • Loading branch information
jpang007 committed Dec 16, 2024
1 parent 5df971a commit bc87418
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions src/connections/destinations/catalog/actions-s3/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ The AWS S3 (Actions) destination enhances this capability by introducing configu

* **Enhanced Delivery Controls**. The destination provides advanced options for batch size controls and file naming conventions. These controls can help optimize efficiency and simplify data retrieval workflows.

## Supported Integrations
The AWS S3 (Actions) Destination supports the following Segment features as supported native Destination integration points:
* rETL
* Classic and Linked Audiences
* Connections

## Getting started
Setting up the AWS S3 (Actions) destination is a straightforward process designed to help you configure and deploy standardized event data to your Amazon S3 bucket. Follow these steps to get started:

Expand All @@ -36,7 +42,7 @@ Ensure you have the following in place before configuring the AWS S3 (Actions) d
- IAM Access IDs: Prepare your AWS IAM ARN ID and IAM External ID. These will be needed to authenticate and authorize Segment with your S3 bucket.


### Step 1: Create an IAM role in the AWS console
## Step 1: Create an IAM role in the AWS console
To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) destination:

1. Log in to your AWS account.
Expand Down Expand Up @@ -69,7 +75,7 @@ To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) d
"Effect": "Allow",
"Principal": {
"AWS":
"arn:aws:iam::595280932656:role/customer-s3-prod-action-destination-access"
"arn:aws:iam::595280932656:role/customer-s3-prod-action-destination-access"
},
"Action": "sts:AssumeRole",
"Condition": {
Expand All @@ -81,8 +87,9 @@ To set up the IAM role to properly authorize Segment with the AWS S3 (Actions) d
]
}
```

## Step 2: Add the AWS S3 (Actions) Destination in Segment
To finish the configuration, enable the AWS S3 (Actions) Destination in your workspace.
To finish the setup, enable the AWS S3 (Actions) Destination in your workspace:

1. Add the **AWS S3 (Actions)** destination from the Destinations tab of the catalog.
2. Select the data source you want to connect to the destination.
Expand All @@ -93,8 +100,17 @@ To finish the configuration, enable the AWS S3 (Actions) Destination in your wor
* Enter the ARN of the IAM role you created above. The ARN should follow the format `arn:aws:iam::ACCOUNT_ID:role/ROLE_NAME.`
* Enter the IAM External ID, which is a value set in the Trust Relationship under your AWS IAM Role.
5. Enable the destination.
6. Verify the Segment data is stored in the S3 bucket by navigating to the `<your_S3_bucket>/` in the AWS console.

{% include components/actions-fields.html settings="true"%}


## Step 3: Configure the AWS S3 (Actions) Destination mappings
To finish the configuration, finalize the mappings of the new AWS S3 (Actions) Destination:

1. Add a new **Sync to S3** Action into the destination.
2. Define the Event Trigger
3. Configure the Column Mappings that are needed, if any of the default columns are **not** needed, leave the value blank. You can also choose to add new mapping fields to set up any customized columns as needed.
4. Configure the Other Settings as needed:
* Enable Batching, Delimiter and File Extension are all required.
* **Note** If the audience_action or batch_size column names are not needed, these fields can be left blank so they do not output on the S3 file.
5. Enable the Mapping and start sending data!
6. Verify the Segment data is stored in the S3 bucket by navigating to the `<your_S3_bucket>/` in the AWS console.

0 comments on commit bc87418

Please sign in to comment.