Skip to content

Commit

Permalink
some fixes to the recording storage documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vagruchi committed Apr 10, 2024
1 parent 160185b commit aa80388
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docusaurus/video/docusaurus/docs/api/recording/storage.mdx
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

0 comments on commit aa80388

Please sign in to comment.