Skip to content
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

Jump to bottom

some fixes to the recording storage documentation #505

Merged
merged 1 commit into from
Apr 15, 2024
Merged

some fixes to the recording storage documentation #505

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 10 additions & 10 deletions docusaurus/video/docusaurus/docs/api/recording/storage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,26 +159,26 @@ curl -X POST "https://video.stream-io-api.com/video/call/default/${CALL_ID}/star

| Name | Description | Required |
|---------------|-------------|----------|
| name | | |
| storage_type | | |
| bucket | | |
| custom_folder | | |
| name |unique name | yes |
| storage_type |s3, gcs or abs| yes |
| bucket |bucket name| yes |
| custom_folder |path inside the bucket| |

## Amazon S3

To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key.

If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.

| Name | Description | Required |
|------------|-------------|----------|
| s3_region | | yes |
| s3_api_key | | |
| s3_secret | | |
| Name | Required |
|------------|----------|
| s3_region | yes |
| s3_api_key | |
| s3_secret | |

There are 2 ways to configure authentication on your S3 bucket:
- By providing a key and secret
- Or by having Stream's AWS account assume a role on your SQS queue.
- Or by having Stream's AWS account assume a role on S3 bucket.
With this option you omit the key and secret, but instead you set up a resource-based policy to grant Stream SendMessage permission on your S3 bucket.
The following policy needs to be attached to your queue (replace the value of Resource with the fully qualified ARN of you S3 bucket):

Expand Down
Loading