Skip to content

Commit 982b5d9

Browse files
docs: Add example about overriding the S3 region (#717)
* docs: Add example about overriding the S3 region * Apply suggestions from code review Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.de> --------- Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.de>
1 parent 25e8d58 commit 982b5d9

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

modules/concepts/pages/s3.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,21 @@ tls:
266266
secretClass: s3-certificate-class
267267
----
268268

269+
== Region override
270+
271+
The `S3Connection` bucket region defaults to `us-east-1`.
272+
If your bucket is in a different region, please set it accordingly.
273+
274+
NOTE: This is mostly useful for AWS S3 buckets, though other implementation might define their own regions.
275+
276+
[source,yaml]
277+
----
278+
...
279+
host: s3.amazonaws.com
280+
region:
281+
name: eu-central-1
282+
----
283+
269284
== What's next
270285

271286
Read the {crd-docs}/s3.stackable.tech/s3bucket/v1alpha1/[S3Bucket CRD reference] and the {crd-docs}/s3.stackable.tech/s3connection/v1alpha1/[S3Connection CRD reference].

0 commit comments

Comments
 (0)