Skip to content

Fix: Add streaming parameters to S3 connector putObject [4.4.0] #2138

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
wso2-engineering-bot wants to merge 1 commit into
base: 4.4.0
Choose a base branch
from
Open

Fix: Add streaming parameters to S3 connector putObject [4.4.0] #2138

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
21 changes: 20 additions & 1 deletion ...ocs/reference/connectors/amazons3-connector/2.x/amazons3-connector-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1868,7 +1868,8 @@ To use the Amazon S3 connector, add the <amazons3.init> element in your configur

!!! note
The `fileContent` parameter is available only with Amazon S3 connector v2.0.2 and above. Either the `filePath` or `fileContent` parameter is mandatory.
The `isContentBase64Encoded` parameter is available only with Amazon S3 connector v2.0.7 and above.
The `isContentBase64Encoded` parameter is available only with Amazon S3 connector v2.0.7 and above.
The `enableStreaming`, `streamingThreshold`, and `streamingPartSize` parameters are available only with Amazon S3 connector v2.0.12 and above.

<table>
<tr>
Expand Down Expand Up @@ -2031,6 +2032,21 @@ To use the Amazon S3 connector, add the <amazons3.init> element in your configur
<td>Specifies whether you want to apply a Legal Hold to the uploaded object.</td>
<td>Optional</td>
</tr>
<tr>
<td>enableStreaming</td>
<td>When set to <code>true</code>, reads upload content directly from the binary payload in the message body as a streaming <code>InputStream</code>, avoiding full in-memory buffering. When enabled, <code>filePath</code> and <code>fileContent</code> must be empty. If the content length is unknown or exceeds <code>streamingThreshold</code>, a multipart upload is used automatically.</td>
<td>Optional</td>
</tr>
<tr>
<td>streamingThreshold</td>
<td>The threshold in bytes at which the connector switches from a single-part upload to a multipart upload when streaming is enabled. Defaults to <code>104857600</code> (100 MB). Requires <code>enableStreaming</code> to be <code>true</code>.</td>
<td>Optional</td>
</tr>
<tr>
<td>streamingPartSize</td>
<td>The part size in bytes for each chunk during a multipart upload. Must be between <code>5242880</code> (5 MB) and <code>2147483647</code> (~2 GB). Defaults to <code>104857600</code> (100 MB). Requires <code>enableStreaming</code> to be <code>true</code>.</td>
<td>Optional</td>
</tr>
</table>

**Sample configuration**
Expand Down Expand Up @@ -2065,6 +2081,9 @@ To use the Amazon S3 connector, add the <amazons3.init> element in your configur
<objectLockMode>{$ctx:objectLockMode}</objectLockMode>
<objectLockRetainUntilDate>{$ctx:objectLockRetainUntilDate}</objectLockRetainUntilDate>
<objectLockLegalHoldStatus>{$ctx:objectLockLegalHoldStatus}</objectLockLegalHoldStatus>
<enableStreaming>{$ctx:enableStreaming}</enableStreaming>
<streamingThreshold>{$ctx:streamingThreshold}</streamingThreshold>
<streamingPartSize>{$ctx:streamingPartSize}</streamingPartSize>
</amazons3.putObject>
```

Expand Down