Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. sls
  5. OssExportSink
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.sls.OssExportSink

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

    Provides a Log Service (SLS) Oss Export Sink resource.

    OSS export task.

    For information about Log Service (SLS) Oss Export Sink and how to use it, see What is Oss Export Sink.

    NOTE: Available since v1.237.0.

    Create OssExportSink Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OssExportSink(name: string, args: OssExportSinkArgs, opts?: CustomResourceOptions);
    @overload
def OssExportSink(resource_name: str,
                  args: OssExportSinkArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def OssExportSink(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[OssExportSinkConfigurationArgs] = None,
                  display_name: Optional[str] = None,
                  job_name: Optional[str] = None,
                  project: Optional[str] = None,
                  description: Optional[str] = None)
    func NewOssExportSink(ctx *Context, name string, args OssExportSinkArgs, opts ...ResourceOption) (*OssExportSink, error)
    public OssExportSink(string name, OssExportSinkArgs args, CustomResourceOptions? opts = null)
    public OssExportSink(String name, OssExportSinkArgs args)
public OssExportSink(String name, OssExportSinkArgs args, CustomResourceOptions options)

    type: alicloud:sls:OssExportSink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OssExportSinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OssExportSinkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OssExportSinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OssExportSinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OssExportSinkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ossExportSinkResource = new AliCloud.Sls.OssExportSink("ossExportSinkResource", new()
{
    Configuration = new AliCloud.Sls.Inputs.OssExportSinkConfigurationArgs
    {
        FromTime = 0,
        Logstore = "string",
        RoleArn = "string",
        Sink = new AliCloud.Sls.Inputs.OssExportSinkConfigurationSinkArgs
        {
            RoleArn = "string",
            BufferInterval = "string",
            BufferSize = "string",
            CompressionType = "string",
            ContentDetail = "string",
            ContentType = "string",
            Bucket = "string",
            Endpoint = "string",
            TimeZone = "string",
            DelaySeconds = 0,
            Prefix = "string",
            PathFormatType = "string",
            Suffix = "string",
            PathFormat = "string",
        },
        ToTime = 0,
    },
    DisplayName = "string",
    JobName = "string",
    Project = "string",
    Description = "string",
});

    example, err := sls.NewOssExportSink(ctx, "ossExportSinkResource", &sls.OssExportSinkArgs{
	Configuration: &sls.OssExportSinkConfigurationArgs{
		FromTime: pulumi.Int(0),
		Logstore: pulumi.String("string"),
		RoleArn:  pulumi.String("string"),
		Sink: &sls.OssExportSinkConfigurationSinkArgs{
			RoleArn:         pulumi.String("string"),
			BufferInterval:  pulumi.String("string"),
			BufferSize:      pulumi.String("string"),
			CompressionType: pulumi.String("string"),
			ContentDetail:   pulumi.String("string"),
			ContentType:     pulumi.String("string"),
			Bucket:          pulumi.String("string"),
			Endpoint:        pulumi.String("string"),
			TimeZone:        pulumi.String("string"),
			DelaySeconds:    pulumi.Int(0),
			Prefix:          pulumi.String("string"),
			PathFormatType:  pulumi.String("string"),
			Suffix:          pulumi.String("string"),
			PathFormat:      pulumi.String("string"),
		},
		ToTime: pulumi.Int(0),
	},
	DisplayName: pulumi.String("string"),
	JobName:     pulumi.String("string"),
	Project:     pulumi.String("string"),
	Description: pulumi.String("string"),
})

    var ossExportSinkResource = new OssExportSink("ossExportSinkResource", OssExportSinkArgs.builder()
    .configuration(OssExportSinkConfigurationArgs.builder()
        .fromTime(0)
        .logstore("string")
        .roleArn("string")
        .sink(OssExportSinkConfigurationSinkArgs.builder()
            .roleArn("string")
            .bufferInterval("string")
            .bufferSize("string")
            .compressionType("string")
            .contentDetail("string")
            .contentType("string")
            .bucket("string")
            .endpoint("string")
            .timeZone("string")
            .delaySeconds(0)
            .prefix("string")
            .pathFormatType("string")
            .suffix("string")
            .pathFormat("string")
            .build())
        .toTime(0)
        .build())
    .displayName("string")
    .jobName("string")
    .project("string")
    .description("string")
    .build());

    oss_export_sink_resource = alicloud.sls.OssExportSink("ossExportSinkResource",
    configuration={
        "from_time": 0,
        "logstore": "string",
        "role_arn": "string",
        "sink": {
            "role_arn": "string",
            "buffer_interval": "string",
            "buffer_size": "string",
            "compression_type": "string",
            "content_detail": "string",
            "content_type": "string",
            "bucket": "string",
            "endpoint": "string",
            "time_zone": "string",
            "delay_seconds": 0,
            "prefix": "string",
            "path_format_type": "string",
            "suffix": "string",
            "path_format": "string",
        },
        "to_time": 0,
    },
    display_name="string",
    job_name="string",
    project="string",
    description="string")

    const ossExportSinkResource = new alicloud.sls.OssExportSink("ossExportSinkResource", {
    configuration: {
        fromTime: 0,
        logstore: "string",
        roleArn: "string",
        sink: {
            roleArn: "string",
            bufferInterval: "string",
            bufferSize: "string",
            compressionType: "string",
            contentDetail: "string",
            contentType: "string",
            bucket: "string",
            endpoint: "string",
            timeZone: "string",
            delaySeconds: 0,
            prefix: "string",
            pathFormatType: "string",
            suffix: "string",
            pathFormat: "string",
        },
        toTime: 0,
    },
    displayName: "string",
    jobName: "string",
    project: "string",
    description: "string",
});

    type: alicloud:sls:OssExportSink
properties:
    configuration:
        fromTime: 0
        logstore: string
        roleArn: string
        sink:
            bucket: string
            bufferInterval: string
            bufferSize: string
            compressionType: string
            contentDetail: string
            contentType: string
            delaySeconds: 0
            endpoint: string
            pathFormat: string
            pathFormatType: string
            prefix: string
            roleArn: string
            suffix: string
            timeZone: string
        toTime: 0
    description: string
    displayName: string
    jobName: string
    project: string

    OssExportSink Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OssExportSink resource accepts the following input properties:

    Configuration Pulumi.AliCloud.Sls.Inputs.OssExportSinkConfiguration
    OSSExportConfiguration See configuration below.
    DisplayName string
    The display name of the job.
    JobName string
    The unique identifier of the OSS data shipping job.
    Project string
    The name of the project.
    Description string
    The description of the job.
    Configuration OssExportSinkConfigurationArgs
    OSSExportConfiguration See configuration below.
    DisplayName string
    The display name of the job.
    JobName string
    The unique identifier of the OSS data shipping job.
    Project string
    The name of the project.
    Description string
    The description of the job.
    configuration OssExportSinkConfiguration
    OSSExportConfiguration See configuration below.
    displayName String
    The display name of the job.
    jobName String
    The unique identifier of the OSS data shipping job.
    project String
    The name of the project.
    description String
    The description of the job.
    configuration OssExportSinkConfiguration
    OSSExportConfiguration See configuration below.
    displayName string
    The display name of the job.
    jobName string
    The unique identifier of the OSS data shipping job.
    project string
    The name of the project.
    description string
    The description of the job.
    configuration OssExportSinkConfigurationArgs
    OSSExportConfiguration See configuration below.
    display_name str
    The display name of the job.
    job_name str
    The unique identifier of the OSS data shipping job.
    project str
    The name of the project.
    description str
    The description of the job.
    configuration Property Map
    OSSExportConfiguration See configuration below.
    displayName String
    The display name of the job.
    jobName String
    The unique identifier of the OSS data shipping job.
    project String
    The name of the project.
    description String
    The description of the job.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OssExportSink resource produces the following output properties:

    CreateTime int
    Creation time. Example value: 1718787534
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the post task. Example value: RUNNING
    CreateTime int
    Creation time. Example value: 1718787534
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the post task. Example value: RUNNING
    createTime Integer
    Creation time. Example value: 1718787534
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the post task. Example value: RUNNING
    createTime number
    Creation time. Example value: 1718787534
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the post task. Example value: RUNNING
    create_time int
    Creation time. Example value: 1718787534
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the post task. Example value: RUNNING
    createTime Number
    Creation time. Example value: 1718787534
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the post task. Example value: RUNNING

    Look up Existing OssExportSink Resource

    Get an existing OssExportSink resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OssExportSinkState, opts?: CustomResourceOptions): OssExportSink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[OssExportSinkConfigurationArgs] = None,
        create_time: Optional[int] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        job_name: Optional[str] = None,
        project: Optional[str] = None,
        status: Optional[str] = None) -> OssExportSink
    func GetOssExportSink(ctx *Context, name string, id IDInput, state *OssExportSinkState, opts ...ResourceOption) (*OssExportSink, error)
    public static OssExportSink Get(string name, Input<string> id, OssExportSinkState? state, CustomResourceOptions? opts = null)
    public static OssExportSink get(String name, Output<String> id, OssExportSinkState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:sls:OssExportSink    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Configuration Pulumi.AliCloud.Sls.Inputs.OssExportSinkConfiguration
    OSSExportConfiguration See configuration below.
    CreateTime int
    Creation time. Example value: 1718787534
    Description string
    The description of the job.
    DisplayName string
    The display name of the job.
    JobName string
    The unique identifier of the OSS data shipping job.
    Project string
    The name of the project.
    Status string
    The status of the post task. Example value: RUNNING
    Configuration OssExportSinkConfigurationArgs
    OSSExportConfiguration See configuration below.
    CreateTime int
    Creation time. Example value: 1718787534
    Description string
    The description of the job.
    DisplayName string
    The display name of the job.
    JobName string
    The unique identifier of the OSS data shipping job.
    Project string
    The name of the project.
    Status string
    The status of the post task. Example value: RUNNING
    configuration OssExportSinkConfiguration
    OSSExportConfiguration See configuration below.
    createTime Integer
    Creation time. Example value: 1718787534
    description String
    The description of the job.
    displayName String
    The display name of the job.
    jobName String
    The unique identifier of the OSS data shipping job.
    project String
    The name of the project.
    status String
    The status of the post task. Example value: RUNNING
    configuration OssExportSinkConfiguration
    OSSExportConfiguration See configuration below.
    createTime number
    Creation time. Example value: 1718787534
    description string
    The description of the job.
    displayName string
    The display name of the job.
    jobName string
    The unique identifier of the OSS data shipping job.
    project string
    The name of the project.
    status string
    The status of the post task. Example value: RUNNING
    configuration OssExportSinkConfigurationArgs
    OSSExportConfiguration See configuration below.
    create_time int
    Creation time. Example value: 1718787534
    description str
    The description of the job.
    display_name str
    The display name of the job.
    job_name str
    The unique identifier of the OSS data shipping job.
    project str
    The name of the project.
    status str
    The status of the post task. Example value: RUNNING
    configuration Property Map
    OSSExportConfiguration See configuration below.
    createTime Number
    Creation time. Example value: 1718787534
    description String
    The description of the job.
    displayName String
    The display name of the job.
    jobName String
    The unique identifier of the OSS data shipping job.
    project String
    The name of the project.
    status String
    The status of the post task. Example value: RUNNING

    Supporting Types

    OssExportSinkConfiguration, OssExportSinkConfigurationArgs

    FromTime int
    The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore. Example value: 1718380800
    Logstore string
    The name of the Logstore.
    RoleArn string
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    Sink Pulumi.AliCloud.Sls.Inputs.OssExportSinkConfigurationSink
    The configurations of the Object Storage Service (OSS) data shipping job. See sink below.
    ToTime int
    The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped. Example value: 1718380800
    FromTime int
    The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore. Example value: 1718380800
    Logstore string
    The name of the Logstore.
    RoleArn string
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    Sink OssExportSinkConfigurationSink
    The configurations of the Object Storage Service (OSS) data shipping job. See sink below.
    ToTime int
    The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped. Example value: 1718380800
    fromTime Integer
    The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore. Example value: 1718380800
    logstore String
    The name of the Logstore.
    roleArn String
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    sink OssExportSinkConfigurationSink
    The configurations of the Object Storage Service (OSS) data shipping job. See sink below.
    toTime Integer
    The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped. Example value: 1718380800
    fromTime number
    The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore. Example value: 1718380800
    logstore string
    The name of the Logstore.
    roleArn string
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    sink OssExportSinkConfigurationSink
    The configurations of the Object Storage Service (OSS) data shipping job. See sink below.
    toTime number
    The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped. Example value: 1718380800
    from_time int
    The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore. Example value: 1718380800
    logstore str
    The name of the Logstore.
    role_arn str
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    sink OssExportSinkConfigurationSink
    The configurations of the Object Storage Service (OSS) data shipping job. See sink below.
    to_time int
    The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped. Example value: 1718380800
    fromTime Number
    The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore. Example value: 1718380800
    logstore String
    The name of the Logstore.
    roleArn String
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    sink Property Map
    The configurations of the Object Storage Service (OSS) data shipping job. See sink below.
    toTime Number
    The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped. Example value: 1718380800

    OssExportSinkConfigurationSink, OssExportSinkConfigurationSinkArgs

    Bucket string
    The OSS bucket.
    BufferInterval string
    The interval between two data shipping operations. Valid values: 300 to 900. Unit: seconds.
    BufferSize string
    The size of the OSS object to which data is shipped. Valid values: 5 to 256. Unit: MB.
    CompressionType string
    Supports four compression types, such as snappy, gzip, zstd, and none.
    ContentDetail string

    The OSS file content details. Note: the value of this parameter should be updated based on the value of the contentType parameter.

    If the contentType value is JSON, the parameters of the contentDetail value are as follows:

    If the tag is allowed to be posted, the value of the parameter enableTag is true. Example:{"enableTag": true}

    You are not allowed to post tags. The value of the parameter enableTag is false. Example:{"enableTag": false}

    If the contentType value is csv, the parameters of the contentDetail value are as follows:

    The parameter columns is the key of the log in the source logstore.

    The delimiter parameter, which can be ",","|","", or "\t".

    The header parameter determines whether the OSS file retains the header. The optional value is true or false.

    The lineFeed parameter. Optional values are "\t", "\n", or "".

    The invalid field content parameter is null to specify the delivery content when the field name does not exist.

    The escape character parameter "quote". Optional values are "" "," '", or" ".

    Example:{"null": "-", "header": false, "lineFeed": "\n", "quote": "", "delimiter": ",", "columns": ["a", "B", "c", "d"]}

    When the contentType value is parquet, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    When the contentType value is set to orc, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    ContentType string
    The storage format of the OSS object. Valid values: json, parquet, csv, and orc.
    Endpoint string
    The OSS Endpoint can only be an OSS intranet Endpoint and only supports the same region. Example value: https://oss-cn-hangzhou-internal.aliyuncs.com
    RoleArn string
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    TimeZone string
    The time zone. Example value: +0800
    DelaySeconds int
    The latency of data shipping. The value of this parameter cannot exceed the data retention period of the source Logstore.
    PathFormat string
    The directory is dynamically generated according to the time. The default value is% Y/%m/%d/%H/%M. The corresponding generated directory is, for example, 2017/01/23/12/00. Note that the partition format cannot start and end. Example values:%Y/%m/%d
    PathFormatType string
    The partition format type. only support time
    Prefix string
    The prefix of the OSS object.
    Suffix string
    The suffix of the OSS object.
    Bucket string
    The OSS bucket.
    BufferInterval string
    The interval between two data shipping operations. Valid values: 300 to 900. Unit: seconds.
    BufferSize string
    The size of the OSS object to which data is shipped. Valid values: 5 to 256. Unit: MB.
    CompressionType string
    Supports four compression types, such as snappy, gzip, zstd, and none.
    ContentDetail string

    The OSS file content details. Note: the value of this parameter should be updated based on the value of the contentType parameter.

    If the contentType value is JSON, the parameters of the contentDetail value are as follows:

    If the tag is allowed to be posted, the value of the parameter enableTag is true. Example:{"enableTag": true}

    You are not allowed to post tags. The value of the parameter enableTag is false. Example:{"enableTag": false}

    If the contentType value is csv, the parameters of the contentDetail value are as follows:

    The parameter columns is the key of the log in the source logstore.

    The delimiter parameter, which can be ",","|","", or "\t".

    The header parameter determines whether the OSS file retains the header. The optional value is true or false.

    The lineFeed parameter. Optional values are "\t", "\n", or "".

    The invalid field content parameter is null to specify the delivery content when the field name does not exist.

    The escape character parameter "quote". Optional values are "" "," '", or" ".

    Example:{"null": "-", "header": false, "lineFeed": "\n", "quote": "", "delimiter": ",", "columns": ["a", "B", "c", "d"]}

    When the contentType value is parquet, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    When the contentType value is set to orc, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    ContentType string
    The storage format of the OSS object. Valid values: json, parquet, csv, and orc.
    Endpoint string
    The OSS Endpoint can only be an OSS intranet Endpoint and only supports the same region. Example value: https://oss-cn-hangzhou-internal.aliyuncs.com
    RoleArn string
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    TimeZone string
    The time zone. Example value: +0800
    DelaySeconds int
    The latency of data shipping. The value of this parameter cannot exceed the data retention period of the source Logstore.
    PathFormat string
    The directory is dynamically generated according to the time. The default value is% Y/%m/%d/%H/%M. The corresponding generated directory is, for example, 2017/01/23/12/00. Note that the partition format cannot start and end. Example values:%Y/%m/%d
    PathFormatType string
    The partition format type. only support time
    Prefix string
    The prefix of the OSS object.
    Suffix string
    The suffix of the OSS object.
    bucket String
    The OSS bucket.
    bufferInterval String
    The interval between two data shipping operations. Valid values: 300 to 900. Unit: seconds.
    bufferSize String
    The size of the OSS object to which data is shipped. Valid values: 5 to 256. Unit: MB.
    compressionType String
    Supports four compression types, such as snappy, gzip, zstd, and none.
    contentDetail String

    The OSS file content details. Note: the value of this parameter should be updated based on the value of the contentType parameter.

    If the contentType value is JSON, the parameters of the contentDetail value are as follows:

    If the tag is allowed to be posted, the value of the parameter enableTag is true. Example:{"enableTag": true}

    You are not allowed to post tags. The value of the parameter enableTag is false. Example:{"enableTag": false}

    If the contentType value is csv, the parameters of the contentDetail value are as follows:

    The parameter columns is the key of the log in the source logstore.

    The delimiter parameter, which can be ",","|","", or "\t".

    The header parameter determines whether the OSS file retains the header. The optional value is true or false.

    The lineFeed parameter. Optional values are "\t", "\n", or "".

    The invalid field content parameter is null to specify the delivery content when the field name does not exist.

    The escape character parameter "quote". Optional values are "" "," '", or" ".

    Example:{"null": "-", "header": false, "lineFeed": "\n", "quote": "", "delimiter": ",", "columns": ["a", "B", "c", "d"]}

    When the contentType value is parquet, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    When the contentType value is set to orc, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    contentType String
    The storage format of the OSS object. Valid values: json, parquet, csv, and orc.
    endpoint String
    The OSS Endpoint can only be an OSS intranet Endpoint and only supports the same region. Example value: https://oss-cn-hangzhou-internal.aliyuncs.com
    roleArn String
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    timeZone String
    The time zone. Example value: +0800
    delaySeconds Integer
    The latency of data shipping. The value of this parameter cannot exceed the data retention period of the source Logstore.
    pathFormat String
    The directory is dynamically generated according to the time. The default value is% Y/%m/%d/%H/%M. The corresponding generated directory is, for example, 2017/01/23/12/00. Note that the partition format cannot start and end. Example values:%Y/%m/%d
    pathFormatType String
    The partition format type. only support time
    prefix String
    The prefix of the OSS object.
    suffix String
    The suffix of the OSS object.
    bucket string
    The OSS bucket.
    bufferInterval string
    The interval between two data shipping operations. Valid values: 300 to 900. Unit: seconds.
    bufferSize string
    The size of the OSS object to which data is shipped. Valid values: 5 to 256. Unit: MB.
    compressionType string
    Supports four compression types, such as snappy, gzip, zstd, and none.
    contentDetail string

    The OSS file content details. Note: the value of this parameter should be updated based on the value of the contentType parameter.

    If the contentType value is JSON, the parameters of the contentDetail value are as follows:

    If the tag is allowed to be posted, the value of the parameter enableTag is true. Example:{"enableTag": true}

    You are not allowed to post tags. The value of the parameter enableTag is false. Example:{"enableTag": false}

    If the contentType value is csv, the parameters of the contentDetail value are as follows:

    The parameter columns is the key of the log in the source logstore.

    The delimiter parameter, which can be ",","|","", or "\t".

    The header parameter determines whether the OSS file retains the header. The optional value is true or false.

    The lineFeed parameter. Optional values are "\t", "\n", or "".

    The invalid field content parameter is null to specify the delivery content when the field name does not exist.

    The escape character parameter "quote". Optional values are "" "," '", or" ".

    Example:{"null": "-", "header": false, "lineFeed": "\n", "quote": "", "delimiter": ",", "columns": ["a", "B", "c", "d"]}

    When the contentType value is parquet, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    When the contentType value is set to orc, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    contentType string
    The storage format of the OSS object. Valid values: json, parquet, csv, and orc.
    endpoint string
    The OSS Endpoint can only be an OSS intranet Endpoint and only supports the same region. Example value: https://oss-cn-hangzhou-internal.aliyuncs.com
    roleArn string
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    timeZone string
    The time zone. Example value: +0800
    delaySeconds number
    The latency of data shipping. The value of this parameter cannot exceed the data retention period of the source Logstore.
    pathFormat string
    The directory is dynamically generated according to the time. The default value is% Y/%m/%d/%H/%M. The corresponding generated directory is, for example, 2017/01/23/12/00. Note that the partition format cannot start and end. Example values:%Y/%m/%d
    pathFormatType string
    The partition format type. only support time
    prefix string
    The prefix of the OSS object.
    suffix string
    The suffix of the OSS object.
    bucket str
    The OSS bucket.
    buffer_interval str
    The interval between two data shipping operations. Valid values: 300 to 900. Unit: seconds.
    buffer_size str
    The size of the OSS object to which data is shipped. Valid values: 5 to 256. Unit: MB.
    compression_type str
    Supports four compression types, such as snappy, gzip, zstd, and none.
    content_detail str

    The OSS file content details. Note: the value of this parameter should be updated based on the value of the contentType parameter.

    If the contentType value is JSON, the parameters of the contentDetail value are as follows:

    If the tag is allowed to be posted, the value of the parameter enableTag is true. Example:{"enableTag": true}

    You are not allowed to post tags. The value of the parameter enableTag is false. Example:{"enableTag": false}

    If the contentType value is csv, the parameters of the contentDetail value are as follows:

    The parameter columns is the key of the log in the source logstore.

    The delimiter parameter, which can be ",","|","", or "\t".

    The header parameter determines whether the OSS file retains the header. The optional value is true or false.

    The lineFeed parameter. Optional values are "\t", "\n", or "".

    The invalid field content parameter is null to specify the delivery content when the field name does not exist.

    The escape character parameter "quote". Optional values are "" "," '", or" ".

    Example:{"null": "-", "header": false, "lineFeed": "\n", "quote": "", "delimiter": ",", "columns": ["a", "B", "c", "d"]}

    When the contentType value is parquet, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    When the contentType value is set to orc, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    content_type str
    The storage format of the OSS object. Valid values: json, parquet, csv, and orc.
    endpoint str
    The OSS Endpoint can only be an OSS intranet Endpoint and only supports the same region. Example value: https://oss-cn-hangzhou-internal.aliyuncs.com
    role_arn str
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    time_zone str
    The time zone. Example value: +0800
    delay_seconds int
    The latency of data shipping. The value of this parameter cannot exceed the data retention period of the source Logstore.
    path_format str
    The directory is dynamically generated according to the time. The default value is% Y/%m/%d/%H/%M. The corresponding generated directory is, for example, 2017/01/23/12/00. Note that the partition format cannot start and end. Example values:%Y/%m/%d
    path_format_type str
    The partition format type. only support time
    prefix str
    The prefix of the OSS object.
    suffix str
    The suffix of the OSS object.
    bucket String
    The OSS bucket.
    bufferInterval String
    The interval between two data shipping operations. Valid values: 300 to 900. Unit: seconds.
    bufferSize String
    The size of the OSS object to which data is shipped. Valid values: 5 to 256. Unit: MB.
    compressionType String
    Supports four compression types, such as snappy, gzip, zstd, and none.
    contentDetail String

    The OSS file content details. Note: the value of this parameter should be updated based on the value of the contentType parameter.

    If the contentType value is JSON, the parameters of the contentDetail value are as follows:

    If the tag is allowed to be posted, the value of the parameter enableTag is true. Example:{"enableTag": true}

    You are not allowed to post tags. The value of the parameter enableTag is false. Example:{"enableTag": false}

    If the contentType value is csv, the parameters of the contentDetail value are as follows:

    The parameter columns is the key of the log in the source logstore.

    The delimiter parameter, which can be ",","|","", or "\t".

    The header parameter determines whether the OSS file retains the header. The optional value is true or false.

    The lineFeed parameter. Optional values are "\t", "\n", or "".

    The invalid field content parameter is null to specify the delivery content when the field name does not exist.

    The escape character parameter "quote". Optional values are "" "," '", or" ".

    Example:{"null": "-", "header": false, "lineFeed": "\n", "quote": "", "delimiter": ",", "columns": ["a", "B", "c", "d"]}

    When the contentType value is parquet, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    When the contentType value is set to orc, the parameters of the contentDetail value are as follows:

    The columns parameter is the key of the log in the source Logstore and must carry the data type of the key, for example:{"columns": [{"name": "a", "type": "string"}, {"name": "B", "type": "string"}, {"name": "c", "type": "string": "string"}]}

    contentType String
    The storage format of the OSS object. Valid values: json, parquet, csv, and orc.
    endpoint String
    The OSS Endpoint can only be an OSS intranet Endpoint and only supports the same region. Example value: https://oss-cn-hangzhou-internal.aliyuncs.com
    roleArn String
    The ARN of the RAM role that is used to write data to OSS. Example value: acs:ram::xxxxxxx
    timeZone String
    The time zone. Example value: +0800
    delaySeconds Number
    The latency of data shipping. The value of this parameter cannot exceed the data retention period of the source Logstore.
    pathFormat String
    The directory is dynamically generated according to the time. The default value is% Y/%m/%d/%H/%M. The corresponding generated directory is, for example, 2017/01/23/12/00. Note that the partition format cannot start and end. Example values:%Y/%m/%d
    pathFormatType String
    The partition format type. only support time
    prefix String
    The prefix of the OSS object.
    suffix String
    The suffix of the OSS object.

    Import

    Log Service (SLS) Oss Export Sink can be imported using the id, e.g.

    $ pulumi import alicloud:sls/ossExportSink:OssExportSink example <project>:<job_name>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-alicloud