Skip to content

Commit 769ed23

Browse files
committed
chore(external docs): Add S3 sink categories
Signed-off-by: binarylogic <[email protected]>
1 parent cb5532b commit 769ed23

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docs/reference/components/sinks/aws_s3.cue

+12-11
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ components: sinks: aws_s3: {
8585

8686
configuration: {
8787
acl: {
88+
category: "ACL"
8889
common: false
8990
description: "Canned ACL to apply to the created objects. For more information, see [Canned ACL][urls.aws_s3_canned_acl]."
9091
required: false
@@ -110,7 +111,7 @@ components: sinks: aws_s3: {
110111
}
111112
}
112113
content_encoding: {
113-
category: "Content Type"
114+
category: "Content Type"
114115
common: false
115116
description: "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. By default calculated from `compression` value."
116117
required: false
@@ -121,7 +122,7 @@ components: sinks: aws_s3: {
121122
}
122123
}
123124
content_type: {
124-
category: "Content Type"
125+
category: "Content Type"
125126
common: false
126127
description: "A standard MIME type describing the format of the contents."
127128
required: false
@@ -131,15 +132,15 @@ components: sinks: aws_s3: {
131132
}
132133
}
133134
filename_append_uuid: {
134-
category: "File Naming"
135+
category: "File Naming"
135136
common: false
136137
description: "Whether or not to append a UUID v4 token to the end of the file. This ensures there are no name collisions high volume use cases."
137138
required: false
138139
warnings: []
139140
type: bool: default: true
140141
}
141142
filename_extension: {
142-
category: "File Naming"
143+
category: "File Naming"
143144
common: false
144145
description: "The filename extension to use in the object name."
145146
required: false
@@ -149,7 +150,7 @@ components: sinks: aws_s3: {
149150
}
150151
}
151152
filename_time_format: {
152-
category: "File Naming"
153+
category: "File Naming"
153154
common: false
154155
description: "The format of the resulting object file name. [`strftime` specifiers](\(urls.strptime_specifiers)) are supported."
155156
required: false
@@ -159,7 +160,7 @@ components: sinks: aws_s3: {
159160
}
160161
}
161162
grant_full_control: {
162-
category: "ACL"
163+
category: "ACL"
163164
common: false
164165
description: "Gives the named [grantee][urls.aws_s3_grantee] READ, READ_ACP, and WRITE_ACP permissions on the created objects."
165166
required: false
@@ -170,7 +171,7 @@ components: sinks: aws_s3: {
170171
}
171172
}
172173
grant_read: {
173-
category: "ACL"
174+
category: "ACL"
174175
common: false
175176
description: "Allows the named [grantee][urls.aws_s3_grantee] to read the created objects and their metadata."
176177
required: false
@@ -181,7 +182,7 @@ components: sinks: aws_s3: {
181182
}
182183
}
183184
grant_read_acp: {
184-
category: "ACL"
185+
category: "ACL"
185186
common: false
186187
description: "Allows the named [grantee][urls.aws_s3_grantee] to read the created objects' ACL."
187188
required: false
@@ -192,7 +193,7 @@ components: sinks: aws_s3: {
192193
}
193194
}
194195
grant_write_acp: {
195-
category: "ACL"
196+
category: "ACL"
196197
common: false
197198
description: "Allows the named [grantee][urls.aws_s3_grantee] to write the created objects' ACL."
198199
required: false
@@ -203,7 +204,7 @@ components: sinks: aws_s3: {
203204
}
204205
}
205206
key_prefix: {
206-
category: "File Naming"
207+
category: "File Naming"
207208
common: true
208209
description: "A prefix to apply to all object key names. This should be used to partition your objects, and it's important to end this value with a `/` if you want this to be the root S3 \"folder\"."
209210
required: false
@@ -239,7 +240,7 @@ components: sinks: aws_s3: {
239240
}
240241
}
241242
storage_class: {
242-
category: "Storage"
243+
category: "Storage"
243244
common: false
244245
description: "The storage class for the created objects. See [the S3 Storage Classes](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) for more details."
245246
required: false

0 commit comments

Comments
 (0)