Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. Shipper
Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.tls.Shipper

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage tls shipper

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";

const foo = new volcengine.tls.Shipper("foo", {
    contentInfo: {
        format: "json",
        jsonInfo: {
            enable: true,
            keys: [
                "__content",
                "__pod_name__",
                "__path__",
                "__tf-test__",
            ],
        },
    },
    shipperEndTime: 1751255700021,
    shipperName: "tf-test",
    shipperStartTime: 1750737324521,
    shipperType: "tos",
    topicId: "8ba48bd7-2493-4300-b1d0-cb7xxxxxx",
    tosShipperInfo: {
        bucket: "tf-test",
        compress: "snappy",
        interval: 100,
        maxSize: 100,
        partitionFormat: "%Y/%m/%d/%H/%M",
        prefix: "terraform_1.9.4_linux_amd64.zip",
    },
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.tls.Shipper("foo",
    content_info=volcengine.tls.ShipperContentInfoArgs(
        format="json",
        json_info=volcengine.tls.ShipperContentInfoJsonInfoArgs(
            enable=True,
            keys=[
                "__content",
                "__pod_name__",
                "__path__",
                "__tf-test__",
            ],
        ),
    ),
    shipper_end_time=1751255700021,
    shipper_name="tf-test",
    shipper_start_time=1750737324521,
    shipper_type="tos",
    topic_id="8ba48bd7-2493-4300-b1d0-cb7xxxxxx",
    tos_shipper_info=volcengine.tls.ShipperTosShipperInfoArgs(
        bucket="tf-test",
        compress="snappy",
        interval=100,
        max_size=100,
        partition_format="%Y/%m/%d/%H/%M",
        prefix="terraform_1.9.4_linux_amd64.zip",
    ))

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tls"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.NewShipper(ctx, "foo", &tls.ShipperArgs{
			ContentInfo: &tls.ShipperContentInfoArgs{
				Format: pulumi.String("json"),
				JsonInfo: &tls.ShipperContentInfoJsonInfoArgs{
					Enable: pulumi.Bool(true),
					Keys: pulumi.StringArray{
						pulumi.String("__content"),
						pulumi.String("__pod_name__"),
						pulumi.String("__path__"),
						pulumi.String("__tf-test__"),
					},
				},
			},
			ShipperEndTime:   pulumi.Int(1751255700021),
			ShipperName:      pulumi.String("tf-test"),
			ShipperStartTime: pulumi.Int(1750737324521),
			ShipperType:      pulumi.String("tos"),
			TopicId:          pulumi.String("8ba48bd7-2493-4300-b1d0-cb7xxxxxx"),
			TosShipperInfo: &tls.ShipperTosShipperInfoArgs{
				Bucket:          pulumi.String("tf-test"),
				Compress:        pulumi.String("snappy"),
				Interval:        pulumi.Int(100),
				MaxSize:         pulumi.Int(100),
				PartitionFormat: pulumi.String("%Y/%m/%d/%H/%M"),
				Prefix:          pulumi.String("terraform_1.9.4_linux_amd64.zip"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Tls.Shipper("foo", new()
    {
        ContentInfo = new Volcengine.Tls.Inputs.ShipperContentInfoArgs
        {
            Format = "json",
            JsonInfo = new Volcengine.Tls.Inputs.ShipperContentInfoJsonInfoArgs
            {
                Enable = true,
                Keys = new[]
                {
                    "__content",
                    "__pod_name__",
                    "__path__",
                    "__tf-test__",
                },
            },
        },
        ShipperEndTime = 1751255700021,
        ShipperName = "tf-test",
        ShipperStartTime = 1750737324521,
        ShipperType = "tos",
        TopicId = "8ba48bd7-2493-4300-b1d0-cb7xxxxxx",
        TosShipperInfo = new Volcengine.Tls.Inputs.ShipperTosShipperInfoArgs
        {
            Bucket = "tf-test",
            Compress = "snappy",
            Interval = 100,
            MaxSize = 100,
            PartitionFormat = "%Y/%m/%d/%H/%M",
            Prefix = "terraform_1.9.4_linux_amd64.zip",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.Shipper;
import com.pulumi.volcengine.tls.ShipperArgs;
import com.pulumi.volcengine.tls.inputs.ShipperContentInfoArgs;
import com.pulumi.volcengine.tls.inputs.ShipperContentInfoJsonInfoArgs;
import com.pulumi.volcengine.tls.inputs.ShipperTosShipperInfoArgs;
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 foo = new Shipper("foo", ShipperArgs.builder()        
            .contentInfo(ShipperContentInfoArgs.builder()
                .format("json")
                .jsonInfo(ShipperContentInfoJsonInfoArgs.builder()
                    .enable(true)
                    .keys(                    
                        "__content",
                        "__pod_name__",
                        "__path__",
                        "__tf-test__")
                    .build())
                .build())
            .shipperEndTime(1751255700021)
            .shipperName("tf-test")
            .shipperStartTime(1750737324521)
            .shipperType("tos")
            .topicId("8ba48bd7-2493-4300-b1d0-cb7xxxxxx")
            .tosShipperInfo(ShipperTosShipperInfoArgs.builder()
                .bucket("tf-test")
                .compress("snappy")
                .interval(100)
                .maxSize(100)
                .partitionFormat("%Y/%m/%d/%H/%M")
                .prefix("terraform_1.9.4_linux_amd64.zip")
                .build())
            .build());

    }
}

    resources:
  foo:
    type: volcengine:tls:Shipper
    properties:
      contentInfo:
        format: json
        jsonInfo:
          enable: true
          keys:
            - __content
            - __pod_name__
            - __path__
            - __tf-test__
      shipperEndTime: 1.751255700021e+12
      shipperName: tf-test
      shipperStartTime: 1.750737324521e+12
      shipperType: tos
      topicId: 8ba48bd7-2493-4300-b1d0-cb7xxxxxx
      tosShipperInfo:
        bucket: tf-test
        compress: snappy
        interval: 100
        maxSize: 100
        partitionFormat: '%Y/%m/%d/%H/%M'
        prefix: terraform_1.9.4_linux_amd64.zip

    Create Shipper Resource

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

    Constructor syntax

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

@overload
def Shipper(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            content_info: Optional[ShipperContentInfoArgs] = None,
            shipper_name: Optional[str] = None,
            topic_id: Optional[str] = None,
            kafka_shipper_info: Optional[ShipperKafkaShipperInfoArgs] = None,
            shipper_end_time: Optional[int] = None,
            shipper_start_time: Optional[int] = None,
            shipper_type: Optional[str] = None,
            status: Optional[bool] = None,
            tos_shipper_info: Optional[ShipperTosShipperInfoArgs] = None)
    func NewShipper(ctx *Context, name string, args ShipperArgs, opts ...ResourceOption) (*Shipper, error)
    public Shipper(string name, ShipperArgs args, CustomResourceOptions? opts = null)
    public Shipper(String name, ShipperArgs args)
public Shipper(String name, ShipperArgs args, CustomResourceOptions options)

    type: volcengine:tls:Shipper
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 ShipperArgs
    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 ShipperArgs
    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 ShipperArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShipperArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShipperArgs
    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 shipperResource = new Volcengine.Tls.Shipper("shipperResource", new()
{
    ContentInfo = new Volcengine.Tls.Inputs.ShipperContentInfoArgs
    {
        CsvInfo = new Volcengine.Tls.Inputs.ShipperContentInfoCsvInfoArgs
        {
            Delimiter = "string",
            EscapeChar = "string",
            Keys = new[]
            {
                "string",
            },
            NonFieldContent = "string",
            PrintHeader = false,
        },
        Format = "string",
        JsonInfo = new Volcengine.Tls.Inputs.ShipperContentInfoJsonInfoArgs
        {
            Enable = false,
            Escape = false,
            Keys = new[]
            {
                "string",
            },
        },
    },
    ShipperName = "string",
    TopicId = "string",
    KafkaShipperInfo = new Volcengine.Tls.Inputs.ShipperKafkaShipperInfoArgs
    {
        Compress = "string",
        Instance = "string",
        KafkaTopic = "string",
        EndTime = 0,
        StartTime = 0,
    },
    ShipperEndTime = 0,
    ShipperStartTime = 0,
    ShipperType = "string",
    Status = false,
    TosShipperInfo = new Volcengine.Tls.Inputs.ShipperTosShipperInfoArgs
    {
        Bucket = "string",
        Compress = "string",
        Interval = 0,
        MaxSize = 0,
        PartitionFormat = "string",
        Prefix = "string",
    },
});

    example, err := tls.NewShipper(ctx, "shipperResource", &tls.ShipperArgs{
	ContentInfo: &tls.ShipperContentInfoArgs{
		CsvInfo: &tls.ShipperContentInfoCsvInfoArgs{
			Delimiter:  pulumi.String("string"),
			EscapeChar: pulumi.String("string"),
			Keys: pulumi.StringArray{
				pulumi.String("string"),
			},
			NonFieldContent: pulumi.String("string"),
			PrintHeader:     pulumi.Bool(false),
		},
		Format: pulumi.String("string"),
		JsonInfo: &tls.ShipperContentInfoJsonInfoArgs{
			Enable: pulumi.Bool(false),
			Escape: pulumi.Bool(false),
			Keys: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ShipperName: pulumi.String("string"),
	TopicId:     pulumi.String("string"),
	KafkaShipperInfo: &tls.ShipperKafkaShipperInfoArgs{
		Compress:   pulumi.String("string"),
		Instance:   pulumi.String("string"),
		KafkaTopic: pulumi.String("string"),
		EndTime:    pulumi.Int(0),
		StartTime:  pulumi.Int(0),
	},
	ShipperEndTime:   pulumi.Int(0),
	ShipperStartTime: pulumi.Int(0),
	ShipperType:      pulumi.String("string"),
	Status:           pulumi.Bool(false),
	TosShipperInfo: &tls.ShipperTosShipperInfoArgs{
		Bucket:          pulumi.String("string"),
		Compress:        pulumi.String("string"),
		Interval:        pulumi.Int(0),
		MaxSize:         pulumi.Int(0),
		PartitionFormat: pulumi.String("string"),
		Prefix:          pulumi.String("string"),
	},
})

    var shipperResource = new Shipper("shipperResource", ShipperArgs.builder()
    .contentInfo(ShipperContentInfoArgs.builder()
        .csvInfo(ShipperContentInfoCsvInfoArgs.builder()
            .delimiter("string")
            .escapeChar("string")
            .keys("string")
            .nonFieldContent("string")
            .printHeader(false)
            .build())
        .format("string")
        .jsonInfo(ShipperContentInfoJsonInfoArgs.builder()
            .enable(false)
            .escape(false)
            .keys("string")
            .build())
        .build())
    .shipperName("string")
    .topicId("string")
    .kafkaShipperInfo(ShipperKafkaShipperInfoArgs.builder()
        .compress("string")
        .instance("string")
        .kafkaTopic("string")
        .endTime(0)
        .startTime(0)
        .build())
    .shipperEndTime(0)
    .shipperStartTime(0)
    .shipperType("string")
    .status(false)
    .tosShipperInfo(ShipperTosShipperInfoArgs.builder()
        .bucket("string")
        .compress("string")
        .interval(0)
        .maxSize(0)
        .partitionFormat("string")
        .prefix("string")
        .build())
    .build());

    shipper_resource = volcengine.tls.Shipper("shipperResource",
    content_info={
        "csv_info": {
            "delimiter": "string",
            "escape_char": "string",
            "keys": ["string"],
            "non_field_content": "string",
            "print_header": False,
        },
        "format": "string",
        "json_info": {
            "enable": False,
            "escape": False,
            "keys": ["string"],
        },
    },
    shipper_name="string",
    topic_id="string",
    kafka_shipper_info={
        "compress": "string",
        "instance": "string",
        "kafka_topic": "string",
        "end_time": 0,
        "start_time": 0,
    },
    shipper_end_time=0,
    shipper_start_time=0,
    shipper_type="string",
    status=False,
    tos_shipper_info={
        "bucket": "string",
        "compress": "string",
        "interval": 0,
        "max_size": 0,
        "partition_format": "string",
        "prefix": "string",
    })

    const shipperResource = new volcengine.tls.Shipper("shipperResource", {
    contentInfo: {
        csvInfo: {
            delimiter: "string",
            escapeChar: "string",
            keys: ["string"],
            nonFieldContent: "string",
            printHeader: false,
        },
        format: "string",
        jsonInfo: {
            enable: false,
            escape: false,
            keys: ["string"],
        },
    },
    shipperName: "string",
    topicId: "string",
    kafkaShipperInfo: {
        compress: "string",
        instance: "string",
        kafkaTopic: "string",
        endTime: 0,
        startTime: 0,
    },
    shipperEndTime: 0,
    shipperStartTime: 0,
    shipperType: "string",
    status: false,
    tosShipperInfo: {
        bucket: "string",
        compress: "string",
        interval: 0,
        maxSize: 0,
        partitionFormat: "string",
        prefix: "string",
    },
});

    type: volcengine:tls:Shipper
properties:
    contentInfo:
        csvInfo:
            delimiter: string
            escapeChar: string
            keys:
                - string
            nonFieldContent: string
            printHeader: false
        format: string
        jsonInfo:
            enable: false
            escape: false
            keys:
                - string
    kafkaShipperInfo:
        compress: string
        endTime: 0
        instance: string
        kafkaTopic: string
        startTime: 0
    shipperEndTime: 0
    shipperName: string
    shipperStartTime: 0
    shipperType: string
    status: false
    topicId: string
    tosShipperInfo:
        bucket: string
        compress: string
        interval: 0
        maxSize: 0
        partitionFormat: string
        prefix: string

    Shipper 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 Shipper resource accepts the following input properties:

    ContentInfo ShipperContentInfo
    Configuration of the delivery format for log content.
    ShipperName string
    Delivery configuration name.
    TopicId string
    The log topic ID where the log to be delivered is located.
    KafkaShipperInfo ShipperKafkaShipperInfo
    JSON format log content configuration.
    ShipperEndTime int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ShipperStartTime int
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ShipperType string
    The type of delivery.
    Status bool
    Whether to enable the delivery configuration. The default value is true.
    TosShipperInfo ShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    ContentInfo ShipperContentInfoArgs
    Configuration of the delivery format for log content.
    ShipperName string
    Delivery configuration name.
    TopicId string
    The log topic ID where the log to be delivered is located.
    KafkaShipperInfo ShipperKafkaShipperInfoArgs
    JSON format log content configuration.
    ShipperEndTime int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ShipperStartTime int
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ShipperType string
    The type of delivery.
    Status bool
    Whether to enable the delivery configuration. The default value is true.
    TosShipperInfo ShipperTosShipperInfoArgs
    Deliver the relevant configuration to the object storage (TOS).
    contentInfo ShipperContentInfo
    Configuration of the delivery format for log content.
    shipperName String
    Delivery configuration name.
    topicId String
    The log topic ID where the log to be delivered is located.
    kafkaShipperInfo ShipperKafkaShipperInfo
    JSON format log content configuration.
    shipperEndTime Integer
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperStartTime Integer
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperType String
    The type of delivery.
    status Boolean
    Whether to enable the delivery configuration. The default value is true.
    tosShipperInfo ShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    contentInfo ShipperContentInfo
    Configuration of the delivery format for log content.
    shipperName string
    Delivery configuration name.
    topicId string
    The log topic ID where the log to be delivered is located.
    kafkaShipperInfo ShipperKafkaShipperInfo
    JSON format log content configuration.
    shipperEndTime number
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperStartTime number
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperType string
    The type of delivery.
    status boolean
    Whether to enable the delivery configuration. The default value is true.
    tosShipperInfo ShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    content_info ShipperContentInfoArgs
    Configuration of the delivery format for log content.
    shipper_name str
    Delivery configuration name.
    topic_id str
    The log topic ID where the log to be delivered is located.
    kafka_shipper_info ShipperKafkaShipperInfoArgs
    JSON format log content configuration.
    shipper_end_time int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipper_start_time int
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipper_type str
    The type of delivery.
    status bool
    Whether to enable the delivery configuration. The default value is true.
    tos_shipper_info ShipperTosShipperInfoArgs
    Deliver the relevant configuration to the object storage (TOS).
    contentInfo Property Map
    Configuration of the delivery format for log content.
    shipperName String
    Delivery configuration name.
    topicId String
    The log topic ID where the log to be delivered is located.
    kafkaShipperInfo Property Map
    JSON format log content configuration.
    shipperEndTime Number
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperStartTime Number
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperType String
    The type of delivery.
    status Boolean
    Whether to enable the delivery configuration. The default value is true.
    tosShipperInfo Property Map
    Deliver the relevant configuration to the object storage (TOS).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Shipper Resource

    Get an existing Shipper 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?: ShipperState, opts?: CustomResourceOptions): Shipper
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        content_info: Optional[ShipperContentInfoArgs] = None,
        kafka_shipper_info: Optional[ShipperKafkaShipperInfoArgs] = None,
        shipper_end_time: Optional[int] = None,
        shipper_name: Optional[str] = None,
        shipper_start_time: Optional[int] = None,
        shipper_type: Optional[str] = None,
        status: Optional[bool] = None,
        topic_id: Optional[str] = None,
        tos_shipper_info: Optional[ShipperTosShipperInfoArgs] = None) -> Shipper
    func GetShipper(ctx *Context, name string, id IDInput, state *ShipperState, opts ...ResourceOption) (*Shipper, error)
    public static Shipper Get(string name, Input<string> id, ShipperState? state, CustomResourceOptions? opts = null)
    public static Shipper get(String name, Output<String> id, ShipperState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:tls:Shipper    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:
    ContentInfo ShipperContentInfo
    Configuration of the delivery format for log content.
    KafkaShipperInfo ShipperKafkaShipperInfo
    JSON format log content configuration.
    ShipperEndTime int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ShipperName string
    Delivery configuration name.
    ShipperStartTime int
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ShipperType string
    The type of delivery.
    Status bool
    Whether to enable the delivery configuration. The default value is true.
    TopicId string
    The log topic ID where the log to be delivered is located.
    TosShipperInfo ShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    ContentInfo ShipperContentInfoArgs
    Configuration of the delivery format for log content.
    KafkaShipperInfo ShipperKafkaShipperInfoArgs
    JSON format log content configuration.
    ShipperEndTime int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ShipperName string
    Delivery configuration name.
    ShipperStartTime int
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    ShipperType string
    The type of delivery.
    Status bool
    Whether to enable the delivery configuration. The default value is true.
    TopicId string
    The log topic ID where the log to be delivered is located.
    TosShipperInfo ShipperTosShipperInfoArgs
    Deliver the relevant configuration to the object storage (TOS).
    contentInfo ShipperContentInfo
    Configuration of the delivery format for log content.
    kafkaShipperInfo ShipperKafkaShipperInfo
    JSON format log content configuration.
    shipperEndTime Integer
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperName String
    Delivery configuration name.
    shipperStartTime Integer
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperType String
    The type of delivery.
    status Boolean
    Whether to enable the delivery configuration. The default value is true.
    topicId String
    The log topic ID where the log to be delivered is located.
    tosShipperInfo ShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    contentInfo ShipperContentInfo
    Configuration of the delivery format for log content.
    kafkaShipperInfo ShipperKafkaShipperInfo
    JSON format log content configuration.
    shipperEndTime number
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperName string
    Delivery configuration name.
    shipperStartTime number
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperType string
    The type of delivery.
    status boolean
    Whether to enable the delivery configuration. The default value is true.
    topicId string
    The log topic ID where the log to be delivered is located.
    tosShipperInfo ShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    content_info ShipperContentInfoArgs
    Configuration of the delivery format for log content.
    kafka_shipper_info ShipperKafkaShipperInfoArgs
    JSON format log content configuration.
    shipper_end_time int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipper_name str
    Delivery configuration name.
    shipper_start_time int
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipper_type str
    The type of delivery.
    status bool
    Whether to enable the delivery configuration. The default value is true.
    topic_id str
    The log topic ID where the log to be delivered is located.
    tos_shipper_info ShipperTosShipperInfoArgs
    Deliver the relevant configuration to the object storage (TOS).
    contentInfo Property Map
    Configuration of the delivery format for log content.
    kafkaShipperInfo Property Map
    JSON format log content configuration.
    shipperEndTime Number
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperName String
    Delivery configuration name.
    shipperStartTime Number
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    shipperType String
    The type of delivery.
    status Boolean
    Whether to enable the delivery configuration. The default value is true.
    topicId String
    The log topic ID where the log to be delivered is located.
    tosShipperInfo Property Map
    Deliver the relevant configuration to the object storage (TOS).

    Supporting Types

    ShipperContentInfo, ShipperContentInfoArgs

    CsvInfo ShipperContentInfoCsvInfo
    CSV format log content configuration.
    Format string
    Log content parsing format.
    JsonInfo ShipperContentInfoJsonInfo
    JSON format log content configuration.
    CsvInfo ShipperContentInfoCsvInfo
    CSV format log content configuration.
    Format string
    Log content parsing format.
    JsonInfo ShipperContentInfoJsonInfo
    JSON format log content configuration.
    csvInfo ShipperContentInfoCsvInfo
    CSV format log content configuration.
    format String
    Log content parsing format.
    jsonInfo ShipperContentInfoJsonInfo
    JSON format log content configuration.
    csvInfo ShipperContentInfoCsvInfo
    CSV format log content configuration.
    format string
    Log content parsing format.
    jsonInfo ShipperContentInfoJsonInfo
    JSON format log content configuration.
    csv_info ShipperContentInfoCsvInfo
    CSV format log content configuration.
    format str
    Log content parsing format.
    json_info ShipperContentInfoJsonInfo
    JSON format log content configuration.
    csvInfo Property Map
    CSV format log content configuration.
    format String
    Log content parsing format.
    jsonInfo Property Map
    JSON format log content configuration.

    ShipperContentInfoCsvInfo, ShipperContentInfoCsvInfoArgs

    Delimiter string
    Delimiters are supported, including commas, tabs, vertical bars, semicolons, and Spaces.
    EscapeChar string
    When the field content contains a delimiter, use an escape character to wrap the field. Currently, only single quotes, double quotes, and null characters are supported.
    Keys List<string>
    Configure the fields that need to be delivered.
    NonFieldContent string
    Invalid field filling content, with a length ranging from 0 to 128.
    PrintHeader bool
    Whether to print the Key on the first line.
    Delimiter string
    Delimiters are supported, including commas, tabs, vertical bars, semicolons, and Spaces.
    EscapeChar string
    When the field content contains a delimiter, use an escape character to wrap the field. Currently, only single quotes, double quotes, and null characters are supported.
    Keys []string
    Configure the fields that need to be delivered.
    NonFieldContent string
    Invalid field filling content, with a length ranging from 0 to 128.
    PrintHeader bool
    Whether to print the Key on the first line.
    delimiter String
    Delimiters are supported, including commas, tabs, vertical bars, semicolons, and Spaces.
    escapeChar String
    When the field content contains a delimiter, use an escape character to wrap the field. Currently, only single quotes, double quotes, and null characters are supported.
    keys List<String>
    Configure the fields that need to be delivered.
    nonFieldContent String
    Invalid field filling content, with a length ranging from 0 to 128.
    printHeader Boolean
    Whether to print the Key on the first line.
    delimiter string
    Delimiters are supported, including commas, tabs, vertical bars, semicolons, and Spaces.
    escapeChar string
    When the field content contains a delimiter, use an escape character to wrap the field. Currently, only single quotes, double quotes, and null characters are supported.
    keys string[]
    Configure the fields that need to be delivered.
    nonFieldContent string
    Invalid field filling content, with a length ranging from 0 to 128.
    printHeader boolean
    Whether to print the Key on the first line.
    delimiter str
    Delimiters are supported, including commas, tabs, vertical bars, semicolons, and Spaces.
    escape_char str
    When the field content contains a delimiter, use an escape character to wrap the field. Currently, only single quotes, double quotes, and null characters are supported.
    keys Sequence[str]
    Configure the fields that need to be delivered.
    non_field_content str
    Invalid field filling content, with a length ranging from 0 to 128.
    print_header bool
    Whether to print the Key on the first line.
    delimiter String
    Delimiters are supported, including commas, tabs, vertical bars, semicolons, and Spaces.
    escapeChar String
    When the field content contains a delimiter, use an escape character to wrap the field. Currently, only single quotes, double quotes, and null characters are supported.
    keys List<String>
    Configure the fields that need to be delivered.
    nonFieldContent String
    Invalid field filling content, with a length ranging from 0 to 128.
    printHeader Boolean
    Whether to print the Key on the first line.

    ShipperContentInfoJsonInfo, ShipperContentInfoJsonInfoArgs

    Enable bool
    Enable the flag.
    Escape bool
    Whether to escape or not. It must be configured as true.
    Keys List<string>
    When delivering in JSON format, if this parameter is not configured, it indicates that all fields have been delivered. Including content (choice), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag____client_ip, tag____receive_time.
    Enable bool
    Enable the flag.
    Escape bool
    Whether to escape or not. It must be configured as true.
    Keys []string
    When delivering in JSON format, if this parameter is not configured, it indicates that all fields have been delivered. Including content (choice), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag____client_ip, tag____receive_time.
    enable Boolean
    Enable the flag.
    escape Boolean
    Whether to escape or not. It must be configured as true.
    keys List<String>
    When delivering in JSON format, if this parameter is not configured, it indicates that all fields have been delivered. Including content (choice), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag____client_ip, tag____receive_time.
    enable boolean
    Enable the flag.
    escape boolean
    Whether to escape or not. It must be configured as true.
    keys string[]
    When delivering in JSON format, if this parameter is not configured, it indicates that all fields have been delivered. Including content (choice), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag____client_ip, tag____receive_time.
    enable bool
    Enable the flag.
    escape bool
    Whether to escape or not. It must be configured as true.
    keys Sequence[str]
    When delivering in JSON format, if this parameter is not configured, it indicates that all fields have been delivered. Including content (choice), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag____client_ip, tag____receive_time.
    enable Boolean
    Enable the flag.
    escape Boolean
    Whether to escape or not. It must be configured as true.
    keys List<String>
    When delivering in JSON format, if this parameter is not configured, it indicates that all fields have been delivered. Including content (choice), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag____client_ip, tag____receive_time.

    ShipperKafkaShipperInfo, ShipperKafkaShipperInfoArgs

    Compress string
    Compression formats currently supported include snappy, gzip, lz4, and none.
    Instance string
    Kafka instance.
    KafkaTopic string
    The name of the Kafka Topic.
    EndTime int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    StartTime int
    Delivery start time, millisecond timestamp. If not configured, the default is the current time.
    Compress string
    Compression formats currently supported include snappy, gzip, lz4, and none.
    Instance string
    Kafka instance.
    KafkaTopic string
    The name of the Kafka Topic.
    EndTime int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    StartTime int
    Delivery start time, millisecond timestamp. If not configured, the default is the current time.
    compress String
    Compression formats currently supported include snappy, gzip, lz4, and none.
    instance String
    Kafka instance.
    kafkaTopic String
    The name of the Kafka Topic.
    endTime Integer
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    startTime Integer
    Delivery start time, millisecond timestamp. If not configured, the default is the current time.
    compress string
    Compression formats currently supported include snappy, gzip, lz4, and none.
    instance string
    Kafka instance.
    kafkaTopic string
    The name of the Kafka Topic.
    endTime number
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    startTime number
    Delivery start time, millisecond timestamp. If not configured, the default is the current time.
    compress str
    Compression formats currently supported include snappy, gzip, lz4, and none.
    instance str
    Kafka instance.
    kafka_topic str
    The name of the Kafka Topic.
    end_time int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    start_time int
    Delivery start time, millisecond timestamp. If not configured, the default is the current time.
    compress String
    Compression formats currently supported include snappy, gzip, lz4, and none.
    instance String
    Kafka instance.
    kafkaTopic String
    The name of the Kafka Topic.
    endTime Number
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    startTime Number
    Delivery start time, millisecond timestamp. If not configured, the default is the current time.

    ShipperTosShipperInfo, ShipperTosShipperInfoArgs

    Bucket string
    When choosing a TOS bucket, it must be located in the same region as the source log topic.
    Compress string
    Compression formats currently supported include snappy, gzip, lz4, and none.
    Interval int
    The delivery time interval, measured in seconds, ranges from 300 to 900.
    MaxSize int
    The maximum size of the original file that can be delivered to each partition (Shard), that is, the size of the uncompressed log file. The unit is MiB, and the value range is 5 to 256.
    PartitionFormat string
    Partition rules for delivering logs.
    Prefix string
    The top-level directory name of the storage bucket. All log data delivered through this delivery configuration will be delivered to this directory.
    Bucket string
    When choosing a TOS bucket, it must be located in the same region as the source log topic.
    Compress string
    Compression formats currently supported include snappy, gzip, lz4, and none.
    Interval int
    The delivery time interval, measured in seconds, ranges from 300 to 900.
    MaxSize int
    The maximum size of the original file that can be delivered to each partition (Shard), that is, the size of the uncompressed log file. The unit is MiB, and the value range is 5 to 256.
    PartitionFormat string
    Partition rules for delivering logs.
    Prefix string
    The top-level directory name of the storage bucket. All log data delivered through this delivery configuration will be delivered to this directory.
    bucket String
    When choosing a TOS bucket, it must be located in the same region as the source log topic.
    compress String
    Compression formats currently supported include snappy, gzip, lz4, and none.
    interval Integer
    The delivery time interval, measured in seconds, ranges from 300 to 900.
    maxSize Integer
    The maximum size of the original file that can be delivered to each partition (Shard), that is, the size of the uncompressed log file. The unit is MiB, and the value range is 5 to 256.
    partitionFormat String
    Partition rules for delivering logs.
    prefix String
    The top-level directory name of the storage bucket. All log data delivered through this delivery configuration will be delivered to this directory.
    bucket string
    When choosing a TOS bucket, it must be located in the same region as the source log topic.
    compress string
    Compression formats currently supported include snappy, gzip, lz4, and none.
    interval number
    The delivery time interval, measured in seconds, ranges from 300 to 900.
    maxSize number
    The maximum size of the original file that can be delivered to each partition (Shard), that is, the size of the uncompressed log file. The unit is MiB, and the value range is 5 to 256.
    partitionFormat string
    Partition rules for delivering logs.
    prefix string
    The top-level directory name of the storage bucket. All log data delivered through this delivery configuration will be delivered to this directory.
    bucket str
    When choosing a TOS bucket, it must be located in the same region as the source log topic.
    compress str
    Compression formats currently supported include snappy, gzip, lz4, and none.
    interval int
    The delivery time interval, measured in seconds, ranges from 300 to 900.
    max_size int
    The maximum size of the original file that can be delivered to each partition (Shard), that is, the size of the uncompressed log file. The unit is MiB, and the value range is 5 to 256.
    partition_format str
    Partition rules for delivering logs.
    prefix str
    The top-level directory name of the storage bucket. All log data delivered through this delivery configuration will be delivered to this directory.
    bucket String
    When choosing a TOS bucket, it must be located in the same region as the source log topic.
    compress String
    Compression formats currently supported include snappy, gzip, lz4, and none.
    interval Number
    The delivery time interval, measured in seconds, ranges from 300 to 900.
    maxSize Number
    The maximum size of the original file that can be delivered to each partition (Shard), that is, the size of the uncompressed log file. The unit is MiB, and the value range is 5 to 256.
    partitionFormat String
    Partition rules for delivering logs.
    prefix String
    The top-level directory name of the storage bucket. All log data delivered through this delivery configuration will be delivered to this directory.

    Import

    Shipper can be imported using the id, e.g.

    $ pulumi import volcengine:tls/shipper:Shipper default resource_id

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.33 published on Monday, Jun 30, 2025 by Volcengine
    volcengine/pulumi-volcengine