Skip to content

AWS S3 Actions - Adding new documentation on supported integrations, and mappings #7330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 18, 2024
Merged

AWS S3 Actions - Adding new documentation on supported integrations, and mappings #7330

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc87418
adding new documentation on supported integrations, and mappings
jpang007 Dec 16, 2024
747b73c
adding event trigger behavior
jpang007 Dec 16, 2024
7321bbc
adding fixes to suggestions
jpang007 Dec 16, 2024
2a64fe8
Apply suggestions from code review
forstisabella Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions src/connections/destinations/catalog/actions-s3/index.md
View file
Open in desktop
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:
* [Reverse ETL](/docs/connections/reverse-etl/)
* [Classic and Linked Audiences](/docs/engage/audiences/)
* [Connections](/docs/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 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.

### Step 2: Add the AWS S3 (Actions) Destination in Segment
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,15 @@ 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, add mappings to your new AWS S3 (Actions) Destination:

1. Add a new **Sync to S3** Action into the destination.
2. Define the Event Trigger. If multiple types are accepted in the Event Trigger, the generated files will automatically be split by type in S3 (for example, you might have a Track events file and an Identify events file).
3. Configure the Column Mappings. If you don't need any of the default columns, leave the value blank. You can also choose to add new mapping fields to set up customized columns as needed.
4. Configure any additional settings as required.
5. Enable the Mapping.
6. Verify that Segment is sending data to your S3 bucket by navigating to `<your_S3_bucket>/` in the AWS console.
Loading