pulumi-alicloud-kotlin/com.pulumi.alicloud.log.kotlin/OssExportArgs

OssExportArgs

data class OssExportArgs(val bucket: Output<String>? = null, val bufferInterval: Output<Int>? = null, val bufferSize: Output<Int>? = null, val compressType: Output<String>? = null, val configColumns: Output<List<OssExportConfigColumnArgs>>? = null, val contentType: Output<String>? = null, val csvConfigColumns: Output<List<String>>? = null, val csvConfigDelimiter: Output<String>? = null, val csvConfigEscape: Output<String>? = null, val csvConfigHeader: Output<Boolean>? = null, val csvConfigLinefeed: Output<String>? = null, val csvConfigNull: Output<String>? = null, val csvConfigQuote: Output<String>? = null, val displayName: Output<String>? = null, val exportName: Output<String>? = null, val fromTime: Output<Int>? = null, val jsonEnableTag: Output<Boolean>? = null, val logReadRoleArn: Output<String>? = null, val logstoreName: Output<String>? = null, val pathFormat: Output<String>? = null, val prefix: Output<String>? = null, val projectName: Output<String>? = null, val roleArn: Output<String>? = null, val suffix: Output<String>? = null, val timeZone: Output<String>? = null) : ConvertibleToJava<OssExportArgs>

Log service data delivery management, this service provides the function of delivering data in logstore to oss product storage. Refer to details.

NOTE: Available in 1.187.0+

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.RandomInteger;
import com.pulumi.random.RandomIntegerArgs;
import com.pulumi.alicloud.log.Project;
import com.pulumi.alicloud.log.ProjectArgs;
import com.pulumi.alicloud.log.Store;
import com.pulumi.alicloud.log.StoreArgs;
import com.pulumi.alicloud.log.OssExport;
import com.pulumi.alicloud.log.OssExportArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var default_ = new RandomInteger("default", RandomIntegerArgs.builder()
            .max(99999)
            .min(10000)
            .build());
        var exampleProject = new Project("exampleProject", ProjectArgs.builder()
            .description("terraform-example")
            .tags(Map.ofEntries(
                Map.entry("Created", "TF"),
                Map.entry("For", "example")
            ))
            .build());
        var exampleStore = new Store("exampleStore", StoreArgs.builder()
            .project(exampleProject.name())
            .retentionPeriod(3650)
            .shardCount(3)
            .autoSplit(true)
            .maxSplitShardCount(60)
            .appendMeta(true)
            .build());
        var exampleOssExport = new OssExport("exampleOssExport", OssExportArgs.builder()
            .projectName(exampleProject.name())
            .logstoreName(exampleStore.name())
            .exportName("terraform-example")
            .displayName("terraform-example")
            .bucket("example-bucket")
            .prefix("root")
            .suffix("")
            .bufferInterval(300)
            .bufferSize(250)
            .compressType("none")
            .pathFormat("%Y/%m/%d/%H/%M")
            .contentType("json")
            .jsonEnableTag(true)
            .roleArn("role_arn_for_oss_write")
            .logReadRoleArn("role_arn_for_sls_read")
            .timeZone("+0800")
            .build());
    }
}
Content copied to clipboard

Import

Log oss export can be imported using the id or name, e.g.

$ pulumi import alicloud:log/ossExport:OssExport example tf-log-project:tf-log-logstore:tf-log-export
Content copied to clipboard

Constructors

Link copied to clipboard
fun OssExportArgs(bucket: Output<String>? = null, bufferInterval: Output<Int>? = null, bufferSize: Output<Int>? = null, compressType: Output<String>? = null, configColumns: Output<List<OssExportConfigColumnArgs>>? = null, contentType: Output<String>? = null, csvConfigColumns: Output<List<String>>? = null, csvConfigDelimiter: Output<String>? = null, csvConfigEscape: Output<String>? = null, csvConfigHeader: Output<Boolean>? = null, csvConfigLinefeed: Output<String>? = null, csvConfigNull: Output<String>? = null, csvConfigQuote: Output<String>? = null, displayName: Output<String>? = null, exportName: Output<String>? = null, fromTime: Output<Int>? = null, jsonEnableTag: Output<Boolean>? = null, logReadRoleArn: Output<String>? = null, logstoreName: Output<String>? = null, pathFormat: Output<String>? = null, prefix: Output<String>? = null, projectName: Output<String>? = null, roleArn: Output<String>? = null, suffix: Output<String>? = null, timeZone: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): OssExportArgs

Properties

Link copied to clipboard
val bucket: Output<String>? = null

The name of the oss bucket.

Link copied to clipboard
val bufferInterval: Output<Int>? = null

How often is it delivered every interval.

Link copied to clipboard
val bufferSize: Output<Int>? = null

Automatically control the creation interval of delivery tasks and set the upper limit of an OSS object size (calculated in uncompressed), unit: MB.

Link copied to clipboard
val compressType: Output<String>? = null

OSS data storage compression method, support: none, snappy, zstd, gzip. Among them, none means that the original data is not compressed, and snappy means that the data is compressed using the snappy algorithm, which can reduce the storage space usage of the OSS Bucket.

Link copied to clipboard
val configColumns: Output<List<OssExportConfigColumnArgs>>? = null

Configure columns when content_type is parquet or orc.

Link copied to clipboard
val contentType: Output<String>? = null

Storage format, only supports three types: json, parquet, orc, csv. According to the different format, please select the following parameters

Link copied to clipboard
val csvConfigColumns: Output<List<String>>? = null

Field configuration in csv content_type.

Link copied to clipboard
val csvConfigDelimiter: Output<String>? = null

Separator configuration in csv content_type.

Link copied to clipboard
val csvConfigEscape: Output<String>? = null

escape in csv content_type.

Link copied to clipboard
val csvConfigHeader: Output<Boolean>? = null

Indicates whether to write the field name to the CSV file, the default value is false.

Link copied to clipboard
val csvConfigLinefeed: Output<String>? = null

lineFeed in csv content_type.

Link copied to clipboard
val csvConfigNull: Output<String>? = null

Invalid field content in csv content_type.

Link copied to clipboard
val csvConfigQuote: Output<String>? = null

Escape character in csv content_type.

Link copied to clipboard
val displayName: Output<String>? = null

The display name for oss export.

Link copied to clipboard
val exportName: Output<String>? = null

Delivery configuration name, it can only contain lowercase letters, numbers, dashes - and underscores _. It must start and end with lowercase letters or numbers, and the name must be 2 to 128 characters long.

Link copied to clipboard
val fromTime: Output<Int>? = null

The log from when to export to oss.

Link copied to clipboard
val jsonEnableTag: Output<Boolean>? = null

Whether to deliver the label when content_type = json.

Link copied to clipboard
val logReadRoleArn: Output<String>? = null

Used for logstore reading, the role should have log read policy, such as acs:ram::13234:role/logrole, if log_read_role_arn is not set, role_arn is used to read logstore.

Link copied to clipboard
val logstoreName: Output<String>? = null

The name of the log logstore.

Link copied to clipboard
val pathFormat: Output<String>? = null

The OSS Bucket directory is dynamically generated according to the creation time of the export task, it cannot start with a forward slash /, the default value is %Y/%m/%d/%H/%M.

Link copied to clipboard
val prefix: Output<String>? = null

The data synchronized from Log Service to OSS will be stored in this directory of Bucket.

Link copied to clipboard
val projectName: Output<String>? = null

The name of the log project. It is the only in one Alicloud account.

Link copied to clipboard
val roleArn: Output<String>? = null

Used to write to oss bucket, the OSS Bucket owner creates the role mark which has the oss bucket write policy, such as acs:ram::13234:role/logrole.

Link copied to clipboard
val suffix: Output<String>? = null

The suffix for the objects in which the shipped data is stored.

Link copied to clipboard
val timeZone: Output<String>? = null

This time zone that is used to format the time, +0800 e.g.