Skip to content

Commit

Permalink
[DOCS] Fix S3 bucket names in S3 repo plugin docs (#66521)
Browse files Browse the repository at this point in the history
Co-authored-by: Inbar Shimshon <[email protected]>
  • Loading branch information
jrodewig and InbarShimshon authored Dec 17, 2020
1 parent 984e7cf commit 6e0befe
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions docs/plugins/repository-s3.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"bucket": "my_bucket"
"bucket": "my-bucket"
}
}
----
Expand All @@ -48,8 +48,8 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"bucket": "my_bucket",
"client": "my_alternate_client"
"bucket": "my-bucket",
"client": "my-alternate-client"
}
}
----
Expand Down Expand Up @@ -241,8 +241,8 @@ PUT _snapshot/my_s3_repository
{
"type": "s3",
"settings": {
"bucket": "my_bucket_name",
"another_setting": "setting_value"
"bucket": "my-bucket",
"another_setting": "setting-value"
}
}
----
Expand All @@ -251,8 +251,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`::

Expand Down Expand Up @@ -340,8 +344,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"
}
}
Expand Down

0 comments on commit 6e0befe

Please sign in to comment.