@@ -105,6 +105,11 @@ The following list contains the available client settings. Those that must be
105105stored in the keystore are marked as "secure" and are *reloadable*; the other
106106settings belong in the `elasticsearch.yml` file.
107107
108+ `region`::
109+ Specifies the region to use. When set, determines the signing region and regional endpoint to use, unless the endpoint
110+ is overridden via the `endpoint` setting. If not set, {es} will attempt to determine the region automatically using
111+ the AWS SDK.
112+
108113`access_key` ({ref}/secure-settings.html[Secure], {ref}/secure-settings.html#reloadable-secure-settings[reloadable])::
109114
110115 An S3 access key. If set, the `secret_key` setting must also be specified.
@@ -121,22 +126,23 @@ settings belong in the `elasticsearch.yml` file.
121126
122127`endpoint`::
123128
124- The S3 service endpoint to connect to. This defaults to `s3.amazonaws.com`
125- but the
126- https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region[AWS
127- documentation] lists alternative S3 endpoints. If you are using an
128- <<repository-s3-compatible-services,S3-compatible service>> then you should
129- set this to the service's endpoint.
129+ The S3 service endpoint to connect to. This defaults to the regional endpoint corresponding to the configured `region`,
130+ but the [AWS documentation](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) lists alternative S3
131+ endpoints. If you are using an [S3-compatible service](#repository-s3-compatible-services) then you should set this
132+ to the service’s endpoint. The endpoint should specify the protocol and host name,
133+ e.g. `https://s3.ap-southeast-4.amazonaws.com`, `http://minio.local:9000`.
134+
135+ When using HTTPS, this repository type validates the repository’s certificate chain using the JVM-wide truststore.
136+ Ensure that the root certificate authority is in this truststore using the JVM’s `keytool` tool. If you have a custom
137+ certificate authority for your S3 repository and you use the {es} [bundled JDK](../../deploy/self-managed/installing-elasticsearch.md#jvm-version),
138+ then you will need to reinstall your CA certificate every time you upgrade {es}.
139+
130140
131141`protocol`::
132142
133- The protocol to use to connect to S3. Valid values are either `http` or
134- `https`. Defaults to `https`. When using HTTPS, this repository type validates the
135- repository's certificate chain using the JVM-wide truststore. Ensure that
136- the root certificate authority is in this truststore using the JVM's
137- `keytool` tool. If you have a custom certificate authority for your S3 repository
138- and you use the {es} <<jvm-version,bundled JDK>>, then you will need to reinstall your
139- CA certificate every time you upgrade {es}.
143+ The protocol to use to connect to S3. Valid values are either `http` or `https`. Defaults to `https`. Note that this
144+ setting is deprecated since 8.19 and is only used if `endpoint` is set to a URL that does not include a scheme.
145+ Users should migrate to including the scheme in the `endpoint` setting.
140146
141147`proxy.host`::
142148
@@ -175,11 +181,6 @@ settings belong in the `elasticsearch.yml` file.
175181 The number of retries to use when an S3 request fails. The default value is
176182 `3`.
177183
178- `use_throttle_retries`::
179-
180- Whether retries should be throttled (i.e. should back off). Must be `true`
181- or `false`. Defaults to `true`.
182-
183184`path_style_access`::
184185
185186 Whether to force the use of the path style access pattern. If `true`, the
@@ -205,23 +206,6 @@ pattern then you should set this setting to `true` when upgrading.
205206 https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/AmazonS3Builder.html#disableChunkedEncoding--[AWS
206207 Java SDK documentation] for details. Defaults to `false`.
207208
208- `region`::
209-
210- Allows specifying the signing region to use. Specificing this setting manually should not be necessary for most use cases. Generally,
211- the SDK will correctly guess the signing region to use. It should be considered an expert level setting to support S3-compatible APIs
212- that require https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html[v4 signatures] and use a region other than the
213- default `us-east-1`. Defaults to empty string which means that the SDK will try to automatically determine the correct signing region.
214-
215- `signer_override`::
216-
217- Allows specifying the name of the signature algorithm to use for signing requests by the S3 client. Specifying this setting should not
218- be necessary for most use cases. It should be considered an expert level setting to support S3-compatible APIs that do not support the
219- signing algorithm that the SDK automatically determines for them.
220- See the
221- https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#setSignerOverride-java.lang.String-[AWS
222- Java SDK documentation] for details. Defaults to empty string which means that no signing algorithm override will be used.
223-
224-
225209[[repository-s3-repository]]
226210==== Repository settings
227211
0 commit comments