Skip to content

Update s3 repository docs _api-reference/snapshots/create-repository.md #11422

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

Merged
merged 4 commits into from
Oct 27, 2025
+2 −0
Merged

Update s3 repository docs _api-reference/snapshots/create-repository.md #11422

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
380369d
Update create-repository.md with S3 options
ICHx Oct 25, 2025
59396d0
Update endpoint description in create-repository.md
ICHx Oct 25, 2025
2e73371
Apply suggestions from code review
kolchfa-aws Oct 27, 2025
7937b02
Apply suggestions from code review
natebower Oct 27, 2025
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
2 changes: 2 additions & 0 deletions _api-reference/snapshots/create-repository.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@
|:--------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `base_path` | The path within the bucket in which you want to store snapshots (for example, `my/snapshot/directory`). Optional. If not specified, snapshots are stored in the S3 bucket root. |
| `bucket` | Name of the S3 bucket. Required. |
| `region` | The AWS Region in which the S3 bucket is located. Optional. If missing, values of `s3.client.default.region` from `opensearch.yml` are used. |
| `endpoint` | The S3 bucket endpoint. Optional. Required if `region` is set for Opensearch 2.9 and later. For example, for `us-west-2`, use `https://s3.us-west-2.amazonaws.com`. If missing, values of `s3.client.default.endpoint` from `opensearch.yml` are used. |

Check failure on line 83 in _api-reference/snapshots/create-repository.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: Opensearch. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: Opensearch. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/snapshots/create-repository.md", "range": {"start": {"line": 83, "column": 117}}}, "severity": "ERROR"}

Check failure on line 83 in _api-reference/snapshots/create-repository.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'OpenSearch' instead of 'Opensearch'.

Raw Output:
{"message": "[Vale.Terms] Use 'OpenSearch' instead of 'Opensearch'.", "location": {"path": "_api-reference/snapshots/create-repository.md", "range": {"start": {"line": 83, "column": 117}}}, "severity": "ERROR"}
| `buffer_size` | The threshold beyond which chunks (of `chunk_size`) should be broken into pieces (of `buffer_size`) and sent to S3 using a different API. Default is the smaller of two values: 100 MB or 5% of the Java heap. Valid values are between `5mb` and `5gb`. We don't recommend changing this option. |
| `canned_acl` | S3 has several [canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) that the `repository-s3` plugin can add to objects as it creates them in S3. Default is `private`. Optional. |
| `chunk_size` | Breaks files into chunks during snapshot operations (for example, `64mb`, `1gb`), which is important for cloud storage providers and far less important for shared file systems. Default is `1gb`. Optional. |
Expand Down
Loading