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

Commit 69e0e9d

Browse files
authored
Merge pull request #82 from triggermesh/s3-docs
Fix s3 documentation to reflect new default behavior of ce-subject and the io.triggermesh.awss3.object.put type
2 parents 6deb643 + 73d902f commit 69e0e9d

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/targets/awss3.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,32 @@ 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+
53+
The S3 bucket key used to store the event is defined by the `ce-subject` attribute.
54+
If `ce-subject` is not set, the default key will be: **ce-type**/**ce-source**/**ce-time**.
55+
5056
This type expects a [JSON][ce-jsonformat] payload with the following properties:
5157

5258
| Name | Value | Description |
5359
|---|---|---|
54-
|**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|
5561
|**ce-subject**|string|The key to use with the assigned bucket for the Target|
5662
|**body**|[JSON][ce-jsonformat]|The data payload to store|
5763

64+
5865
The response [CloudEvent][ce] would have the following payload:
5966

6067
| Name | Value | Description |
6168
|---|---|---|
62-
|**ce-type**|io.triggermesh.targets.aws.s3.result|Denotes a response payload from S3|
63-
|**ce-source**|`arn:aws:s3:...`|The S3 ARN value as configured by the target|
64-
|**body**|[JSON][ce-jsonformat]|A JSON response from the Target invocation|
65-
69+
|**ce-type**|io.triggermesh.targets.aws.s3.result|Denotes a response payload from the S3 put request|
70+
|**ce-source**|`arn:aws:s3:...`|The S3's bucket ARN value as configured by the target|
71+
|**body**|[JSON][ce-jsonformat]|A JSON response from the Target invocation with the Etag associated with the request|
6672

6773

6874
[ce]: https://cloudevents.io/

0 commit comments

Comments
 (0)