Skip to content

Commit

Permalink
chore(external docs): Add S3 sink categories
Browse files Browse the repository at this point in the history
Signed-off-by: binarylogic <[email protected]>
Signed-off-by: Duy Do <[email protected]>
  • Loading branch information
binarylogic committed Oct 17, 2020
1 parent 706474e commit 0433a6e
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions docs/reference/components/sinks/aws_s3.cue
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ components: sinks: aws_s3: {

configuration: {
acl: {
category: "ACL"
common: false
description: "Canned ACL to apply to the created objects. For more information, see [Canned ACL][urls.aws_s3_canned_acl]."
required: false
Expand All @@ -110,7 +111,7 @@ components: sinks: aws_s3: {
}
}
content_encoding: {
category: "Content Type"
category: "Content Type"
common: false
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."
required: false
Expand All @@ -121,7 +122,7 @@ components: sinks: aws_s3: {
}
}
content_type: {
category: "Content Type"
category: "Content Type"
common: false
description: "A standard MIME type describing the format of the contents."
required: false
Expand All @@ -131,15 +132,15 @@ components: sinks: aws_s3: {
}
}
filename_append_uuid: {
category: "File Naming"
category: "File Naming"
common: false
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."
required: false
warnings: []
type: bool: default: true
}
filename_extension: {
category: "File Naming"
category: "File Naming"
common: false
description: "The filename extension to use in the object name."
required: false
Expand All @@ -149,7 +150,7 @@ components: sinks: aws_s3: {
}
}
filename_time_format: {
category: "File Naming"
category: "File Naming"
common: false
description: "The format of the resulting object file name. [`strftime` specifiers](\(urls.strptime_specifiers)) are supported."
required: false
Expand All @@ -159,7 +160,7 @@ components: sinks: aws_s3: {
}
}
grant_full_control: {
category: "ACL"
category: "ACL"
common: false
description: "Gives the named [grantee][urls.aws_s3_grantee] READ, READ_ACP, and WRITE_ACP permissions on the created objects."
required: false
Expand All @@ -170,7 +171,7 @@ components: sinks: aws_s3: {
}
}
grant_read: {
category: "ACL"
category: "ACL"
common: false
description: "Allows the named [grantee][urls.aws_s3_grantee] to read the created objects and their metadata."
required: false
Expand All @@ -181,7 +182,7 @@ components: sinks: aws_s3: {
}
}
grant_read_acp: {
category: "ACL"
category: "ACL"
common: false
description: "Allows the named [grantee][urls.aws_s3_grantee] to read the created objects' ACL."
required: false
Expand All @@ -192,7 +193,7 @@ components: sinks: aws_s3: {
}
}
grant_write_acp: {
category: "ACL"
category: "ACL"
common: false
description: "Allows the named [grantee][urls.aws_s3_grantee] to write the created objects' ACL."
required: false
Expand All @@ -203,7 +204,7 @@ components: sinks: aws_s3: {
}
}
key_prefix: {
category: "File Naming"
category: "File Naming"
common: true
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\"."
required: false
Expand Down Expand Up @@ -239,7 +240,7 @@ components: sinks: aws_s3: {
}
}
storage_class: {
category: "Storage"
category: "Storage"
common: false
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."
required: false
Expand Down

0 comments on commit 0433a6e

Please sign in to comment.