Skip to content

Commit 99cfdb5

Browse files
DOCSP-11259 Relax to S3 region requirement (#48)
1 parent 9d36414 commit 99cfdb5

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

source/reference/pipeline/out.txt

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,10 @@ Fields
157157

158158
* - ``s3.region``
159159
- string
160-
- Name of the |aws| region in which the bucket is hosted.
161-
- Required
160+
- Name of the |aws| region in which the bucket is hosted. If
161+
omitted, uses the {+dl+} :ref:`configuration <datalake-configuration-file>` to determine the region where the
162+
specified ``s3.bucket`` is hosted.
163+
- Optional
162164

163165
* - ``s3.filename``
164166
- string
@@ -309,7 +311,7 @@ Examples
309311
.. example::
310312

311313
You want to write 1 GiB of data as compressed |bson| files to
312-
an |s3| bucket named ``my-s3-bucket``.
314+
an |s3| bucket named ``my-s3-bucket``.
313315

314316
Using the following |out| syntax:
315317

@@ -320,7 +322,6 @@ Examples
320322
"$out": {
321323
"s3": {
322324
"bucket": "my-s3-bucket",
323-
"region": "us-east-1",
324325
"filename": "big_box_store/",
325326
"format": {
326327
"name": "bson.gz"
@@ -329,7 +330,9 @@ Examples
329330
}
330331
}
331332

332-
|out| writes five compressed |bson| files:
333+
The ``s3.region`` is omitted and so, {+dl+} determines the
334+
region where the bucket named ``my-s3-bucket`` is hosted from the
335+
storage configuration. |out| writes five compressed |bson| files:
333336

334337
1. The first 200 MiB of data to a file that |out| names
335338
``big_box_store/1.bson.gz``.

0 commit comments

Comments
 (0)