Skip to content

Commit 46acd77

Browse files
Add some documentation
1 parent 5ae7d4e commit 46acd77

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/plugins/repository-s3.asciidoc

+26
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,32 @@ The following settings are supported:
221221
currently supported by the plugin. For more information about the
222222
different classes, see http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html[AWS Storage Classes Guide]
223223

224+
NOTE: The option of defining client settings in the repository settings as documented below is considered deprecated:
225+
226+
In addition to the above settings, you may also specify all non-secure client settings in the repository settings.
227+
In this case, the client settings found in the repository settings will be merged with those of the named client used by the repository.
228+
Conflicts between client and repository settings are resolved by the repository settings taking precedence over client settings.
229+
230+
For example:
231+
232+
[source,js]
233+
----
234+
PUT _snapshot/my_s3_repository
235+
{
236+
"type": "s3",
237+
"settings": {
238+
"client": "my_client_name",
239+
"bucket": "my_bucket_name",
240+
"endpoint": "my.s3.endpoint"
241+
}
242+
}
243+
----
244+
// CONSOLE
245+
// TEST[skip:we don't have s3 set up while testing this]
246+
247+
This sets up a repository that uses all client settings from the client `my_client_named` except for the `endpoint` that is overridden
248+
to `my.s3.endpoint` by the repository settings.
249+
224250
[[repository-s3-permissions]]
225251
===== Recommended S3 Permissions
226252

0 commit comments

Comments
 (0)