Skip to content

ENG-2459 - Change 's3' dataSourceDescriptor and secretType to 'aws' #3

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

Open
chandrashekhar07 wants to merge 1 commit into
base: gitbook-sync
Choose a base branch
from
Open

ENG-2459 - Change 's3' dataSourceDescriptor and secretType to 'aws' #3

Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions launch-with-bytenite/data-sources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Please see [#supported-data-source-options](./#supported-data-source-options "me

**Example:**

"s3"
"aws"

</details>

Expand Down Expand Up @@ -132,7 +132,7 @@ Here's an example of a secret request body:
"secret": {
"id": "aws_full_s3_access_key",
"name": "John's AWS S3 Full Bucket Access",
"secretType": "s3",
"secretType": "aws",
"accessKey": "AKIAXXEXAMPLEEXAMPLEX",
"expiresAt": "2025-12-29T18:02:27.140Z"
},
Expand Down Expand Up @@ -177,7 +177,7 @@ Use `bypass` to skip a data source.

**Example:**

"s3"
"aws"

</details>

Expand Down Expand Up @@ -215,7 +215,7 @@ Here is a full `dataSource` object example:
```json
{
"dataSource": {
"dataSourceDescriptor": "s3",
"dataSourceDescriptor": "aws",
"params": {
"@type": "type.googleapis.com/bytenite.data_source.S3DataSource",
"name": "/vids/big_buck_bunny.mp4",
Expand Down
12 changes: 6 additions & 6 deletions launch-with-bytenite/data-sources/aws-s3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ In the AWS Console, search for **IAM** and go to **Users**.&#x20;
## S3 Secret

{% hint style="info" %}
`secretType` : **`s3`**
`secretType` : **`aws`**
{% endhint %}

If your S3 bucket requires authentication for read or write access, set up a secret to store your S3 credentials securely with ByteNite (see [#setting-up-secrets](./#setting-up-secrets "mention"))
Expand All @@ -66,7 +66,7 @@ Here's an example of a request body of the [secrets.md](../../api-reference/auth
{
"secret": {
"id": "my_aws_secret",
"secretType": "s3",
"secretType": "aws",
"expiresAt": "2025-12-29T18:02:27.140Z",
"accessKey": "AKIAXXEXAMPLEEXAMPLEX",
"name": "My AWS Full Bucket Access"
Expand All @@ -83,7 +83,7 @@ Here's an example of a request body of the [secrets.md](../../api-reference/auth
## S3 Data Source Object

{% hint style="info" %}
`dataSourceDescriptor` : **`s3`**
`dataSourceDescriptor` : **`aws`**

`@type` : [**`type.googleapis.com/bytenite.data_source.S3DataSource`**](#user-content-fn-1)[^1]&#x20;
{% endhint %}
Expand Down Expand Up @@ -154,7 +154,7 @@ The S3 bucket's region name.

**Description:**

The ID of an existing `s3` secret.
The ID of an existing `aws` secret.

**Example:**

Expand All @@ -170,7 +170,7 @@ Here is an example S3 data source and destination request body:
```json
{
"dataSource": {
"dataSourceDescriptor": "s3",
"dataSourceDescriptor": "aws",
"params": {
"@type": "type.googleapis.com/bytenite.data_source.S3DataSource",
"name": "/vids/big_buck_bunny.mp4",
Expand All @@ -181,7 +181,7 @@ Here is an example S3 data source and destination request body:
},

"dataDestination": {
"dataSourceDescriptor": "s3",
"dataSourceDescriptor": "aws",
"params": {
"@type": "type.googleapis.com/bytenite.data_source.S3DataSource",
"name": "/vids/encoded/",
Expand Down