honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Fix S3 bucket names in S3 repo plugin docs (#66521) (#66529) 

Co-authored-by: Inbar Shimshon <inbar.shimshon@elastic.co>
This commit is contained in:
James Rodewig 2020-12-17 10:27:57 -05:00 committed by GitHub
parent c17b409237
commit 499f4a09e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/plugins/repository-s3.asciidoc
View File

@ -27,7 +27,7 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"bucket": "my_bucket"
"bucket": "my-bucket"
}
}
----
@ -54,8 +54,8 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"bucket": "my_bucket",
"client": "my_alternate_client"
"bucket": "my-bucket",
"client": "my-alternate-client"
}
}
----
@ -247,8 +247,8 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"bucket": "my_bucket_name",
"another_setting": "setting_value"
"bucket": "my-bucket",
"another_setting": "setting-value"
}
}
----
@ -257,8 +257,12 @@ PUT _snapshot/my_s3_repository
The following settings are supported:
`bucket`::
The name of the bucket to be used for snapshots. (Mandatory)
(Required)
Name of the S3 bucket to use for snapshots.
+
The bucket name must adhere to Amazon's
https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules[S3
bucket naming rules].
`client`::
@ -346,8 +350,8 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"client": "my_client_name",
"bucket": "my_bucket_name",
"client": "my-client",
"bucket": "my-bucket",
"endpoint": "my.s3.endpoint"
}
}