Skip to main content
Version: 1.x

S3

Output plugin : S3​

Description​

Write Rows to AWS S3 storage.

Options​

nametyperequireddefault value
optionsobjectno-
partition_byarrayno-
pathstringyes-
path_time_formatstringnoyyyyMMddHHmmss
save_modestringnoerror
formatstringnojson
options [object]​

Custom parameters.

partition_by [array]​

Partition the data based on the fields.

path [string]​

File path on AWS S3 storage. Start with s3://, s3a:// or s3n://.

path_time_format [string]​

If path contains time variables, such as xxxx-${now}, path_time_format can be used to specify the format of s3 path, default is yyyy.MM.dd. The commonly used time formats are listed below:

SymbolDescription
yYear
MMonth
dDay of month
HHour in day (0-23)
mMinute in hour
sSecond in minute

The detailed time format syntax:Java SimpleDateFormat.

save_mode [string]​

Save mode, supports overwrite, append, ignore and error. The detail of save_mode see save-modes.

format [string]​

Output format, supports csv, json, parquet and text.

Example​

s3 {
path = "s3a://var/logs"
format = "parquet"
}