Skip to content

Commit 10dfacb

Browse files
authored
Merge pull request #495 from daipom/1.0-out_http-add-new-option-aws_sigv4
out_http: Add descriptions about AWS Signature Version 4 support
2 parents a0ea445 + 5557589 commit 10dfacb

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
@@ -273,7 +273,20 @@ The list of retryable response codes. If the response code is included in this l
273273

274274
### `<auth>` Section
275275

276-
Specifies HTTP authentication:
276+
Specifies HTTP authentication.
277+
278+
#### `method`
279+
280+
| type | default | available values | version |
281+
| :--- | :--- | :--- | :--- |
282+
| enum | basic | basic/aws\_sigv4 | basic:1.7.0 / aws\_sigv4:1.17.0 |
283+
284+
The method for HTTP authentication.
285+
286+
* `basic`: basic authentication
287+
* `aws_sigv4`: [AWS Signature Version 4](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html)
288+
289+
#### Parameters for `method basic`
277290

278291
```text
279292
<auth>
@@ -283,30 +296,65 @@ Specifies HTTP authentication:
283296
</auth>
284297
```
285298

286-
#### `method`
287-
288-
| type | default | available values | version |
289-
| :--- | :--- | :--- | :--- |
290-
| enum | basic | basic | 1.7.0 |
291-
292-
The method for HTTP authentication. Now only `basic`.
293-
294-
#### `username`
299+
##### `username`
295300

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

300305
The username for basic authentication.
301306

302-
#### `password`
307+
##### `password`
303308

304309
| type | default | version |
305310
| :--- | :--- | :--- |
306311
| string | nil | 1.7.0 |
307312

308313
The password for basic authentication.
309314

315+
#### Parameters for `method aws_sigv4`
316+
317+
Parameters for [AWS Signature Version 4](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
318+
319+
```text
320+
<auth>
321+
method aws_sigv4
322+
aws_service osis
323+
aws_region us-east-1
324+
aws_role_arn arn:aws:iam::123456789012:role/MyRole
325+
</auth>
326+
```
327+
328+
##### `aws_service`
329+
330+
| type | default | version |
331+
| :--- | :--- | :--- |
332+
| string | nil | 1.17.0 |
333+
334+
The AWS service to authenticate against.
335+
336+
This parameter is required when you specify `aws_sigv4` for `method`.
337+
338+
##### `aws_region`
339+
340+
| type | default | version |
341+
| :--- | :--- | :--- |
342+
| string | nil | 1.17.0 |
343+
344+
The AWS region to use when authenticating.
345+
346+
This parameter is required when you specify `aws_sigv4` for `method`.
347+
348+
##### `aws_role_arn`
349+
350+
| type | default | version |
351+
| :--- | :--- | :--- |
352+
| string | nil | 1.17.0 |
353+
354+
The AWS role ARN to assume when authenticating.
355+
356+
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.
357+
310358
## Common Output / Buffer parameters
311359

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

0 commit comments

Comments
 (0)