Skip to content

Commit 5557589

Browse files
committed
out_http: Add descriptions about AWS Signature Version 4 support
New feature of Fluentd v1.17.0. Related: fluent/fluentd#4459 Signed-off-by: Daijiro Fukuda <fukuda@clear-code.com>
1 parent 80e2e6c commit 5557589

File tree

1 file changed

+59
-11
lines changed

1 file changed

+59
-11
lines changed

output/http.md

Lines changed: 59 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,20 @@ The list of retryable response codes. If the response code is included in this l
265265

266266
### `<auth>` Section
267267

268-
Specifies HTTP authentication:
268+
Specifies HTTP authentication.
269+
270+
#### `method`
271+
272+
| type | default | available values | version |
273+
| :--- | :--- | :--- | :--- |
274+
| enum | basic | basic/aws\_sigv4 | basic:1.7.0 / aws\_sigv4:1.17.0 |
275+
276+
The method for HTTP authentication.
277+
278+
* `basic`: basic authentication
279+
* `aws_sigv4`: [AWS Signature Version 4](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html)
280+
281+
#### Parameters for `method basic`
269282

270283
```text
271284
<auth>
@@ -275,30 +288,65 @@ Specifies HTTP authentication:
275288
</auth>
276289
```
277290

278-
#### `method`
279-
280-
| type | default | available values | version |
281-
| :--- | :--- | :--- | :--- |
282-
| enum | basic | basic | 1.7.0 |
283-
284-
The method for HTTP authentication. Now only `basic`.
285-
286-
#### `username`
291+
##### `username`
287292

288293
| type | default | version |
289294
| :--- | :--- | :--- |
290295
| string | nil | 1.7.0 |
291296

292297
The username for basic authentication.
293298

294-
#### `password`
299+
##### `password`
295300

296301
| type | default | version |
297302
| :--- | :--- | :--- |
298303
| string | nil | 1.7.0 |
299304

300305
The password for basic authentication.
301306

307+
#### Parameters for `method aws_sigv4`
308+
309+
Parameters for [AWS Signature Version 4](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
310+
311+
```text
312+
<auth>
313+
method aws_sigv4
314+
aws_service osis
315+
aws_region us-east-1
316+
aws_role_arn arn:aws:iam::123456789012:role/MyRole
317+
</auth>
318+
```
319+
320+
##### `aws_service`
321+
322+
| type | default | version |
323+
| :--- | :--- | :--- |
324+
| string | nil | 1.17.0 |
325+
326+
The AWS service to authenticate against.
327+
328+
This parameter is required when you specify `aws_sigv4` for `method`.
329+
330+
##### `aws_region`
331+
332+
| type | default | version |
333+
| :--- | :--- | :--- |
334+
| string | nil | 1.17.0 |
335+
336+
The AWS region to use when authenticating.
337+
338+
This parameter is required when you specify `aws_sigv4` for `method`.
339+
340+
##### `aws_role_arn`
341+
342+
| type | default | version |
343+
| :--- | :--- | :--- |
344+
| string | nil | 1.17.0 |
345+
346+
The AWS role ARN to assume when authenticating.
347+
348+
This parameter is optional when you specify `aws_sigv4` for `method`. If you provide it, Fluentd will assume that AWS role and send requests signing from that role. Otherwise, Fluentd will use the credentials found by the [credential provider chain](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html) as defined in the AWS documentation.
349+
302350
## Common Output / Buffer parameters
303351

304352
For common output / buffer parameters, please check the following articles:

0 commit comments

Comments
 (0)