Skip to content
This repository was archived by the owner on May 5, 2025. It is now read-only.

Commit 73d902f

Browse files
committed
Simplify description of s3 target notes
1 parent 0433214 commit 73d902f

File tree

1 file changed

+7
-21
lines changed

1 file changed

+7
-21
lines changed

docs/targets/awss3.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -43,38 +43,24 @@ For more information about using AWS S3, please refer to the [AWS documentation]
4343

4444
## Event Types
4545

46-
### io.triggermesh.awss3.object.put
47-
4846
Events of this type will store the event payload into an s3 bucket.
4947

48+
The AWS S3 Target leaves the [CloudEvent][ce] type definition to the discretion of
49+
the implementer given the flexible nature of what can be stored in S3. There is
50+
an exception if the `io.triggermesh.awss3.object.put` type is used where the target
51+
will store the payload body regardless of the `Discard CloudEvent context attributes` setting.
52+
5053
The S3 bucket key used to store the event is defined by the `ce-subject` attribute.
51-
However, if `ce-subject` is not set, the default key will be: **ce-type**/**ce-source**/**ce-time**.
54+
If `ce-subject` is not set, the default key will be: **ce-type**/**ce-source**/**ce-time**.
5255

5356
This type expects a [JSON][ce-jsonformat] payload with the following properties:
5457

5558
| Name | Value | Description |
5659
|---|---|---|
57-
|**ce-type**|io.triggermesh.awss3.object.put|Event type denoting the s3 put request|
60+
|**ce-type**|io.triggermesh.awss3.object.put or user defined|Event type denoting the s3 put request|
5861
|**ce-subject**|string|The key to use with the assigned bucket for the Target|
5962
|**body**|[JSON][ce-jsonformat]|The data payload to store|
6063

61-
The response [CloudEvent][ce] would have the following payload:
62-
63-
| Name | Value | Description |
64-
|---|---|---|
65-
|**ce-type**|io.triggermesh.targets.aws.s3.result|Denotes a response payload from the S3 put request|
66-
|**ce-source**|`arn:aws:s3:...`|The S3's bucket ARN value as configured by the target|
67-
|**body**|[JSON][ce-jsonformat]|A JSON response from the Target invocation with the Etag associated with the request|
68-
69-
### * Types
70-
71-
The AWS S3 Target leaves the [CloudEvent][ce] type definition to the discretion of
72-
the implementer given the flexible nature of what can be stored in S3. There is
73-
an exception for the `io.triggermesh.awss3.object.put`, documented above, where
74-
it will store the payload body regardless of the `Discard CloudEvent context attributes` setting.
75-
76-
The S3 bucket key used to store the event is defined by the `ce-subject` attribute.
77-
However, if `ce-subject` is not set, the default key will be: **ce-type**/**ce-source**/**ce-time**.
7864

7965
The response [CloudEvent][ce] would have the following payload:
8066

0 commit comments

Comments
 (0)