Shipper

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  tLSShipperDemo:
    type: volcenginecc:tls:Shipper
    name: TLSShipperDemo
    properties:
      contentInfo:
        format: json
        json_info:
          enable: true
          escape: true
          keys:
            - __content__
            - __source__
            - __path__
            - __time__
            - __time_ns_part__
            - __image_name__
            - __container_name__
            - __container_ip__
            - __container_source__
            - __pod_ip__
            - __pod_name__
            - __pod_uid__
            - __namespace__
            - __tag____client_ip__
            - __tag____receive_time__
      kafkaShipperInfo:
        compress: gzip
        end_time: 1.777538948e+12
        instance: kafka-cnngsl83xxxxxxxx
        kafka_topic: topic1
      shipperEndTime: 1.777538948e+12
      shipperName: ccapi-test-kaf-1001
      shipperType: kafka
      topicId: b75fffd8-1986-460c-9cca-5axxxxxxx
      status: false

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: volcenginecc: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.

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 Volcengine.ShipperContentInfo: Log content delivery format configuration.
ShipperName string: Delivery configuration name, unique within a log project.
TopicId string: Log topic ID.
KafkaShipperInfo Volcengine.ShipperKafkaShipperInfo: Kafka delivery configuration.
ShipperEndTime int: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
ShipperStartTime int: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
ShipperType string: Type of data source for delivery. Options: tos, kafka. Default is tos.
Status bool: Whether to enable delivery configuration. Default is true.
TosShipperInfo Volcengine.ShipperTosShipperInfo: Information related to delivery to TOS object storage.

ContentInfo ShipperContentInfoArgs: Log content delivery format configuration.
ShipperName string: Delivery configuration name, unique within a log project.
TopicId string: Log topic ID.
KafkaShipperInfo ShipperKafkaShipperInfoArgs: Kafka delivery configuration.
ShipperEndTime int: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
ShipperStartTime int: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
ShipperType string: Type of data source for delivery. Options: tos, kafka. Default is tos.
Status bool: Whether to enable delivery configuration. Default is true.
TosShipperInfo ShipperTosShipperInfoArgs: Information related to delivery to TOS object storage.

contentInfo ShipperContentInfo: Log content delivery format configuration.
shipperName String: Delivery configuration name, unique within a log project.
topicId String: Log topic ID.
kafkaShipperInfo ShipperKafkaShipperInfo: Kafka delivery configuration.
shipperEndTime Integer: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperStartTime Integer: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperType String: Type of data source for delivery. Options: tos, kafka. Default is tos.
status Boolean: Whether to enable delivery configuration. Default is true.
tosShipperInfo ShipperTosShipperInfo: Information related to delivery to TOS object storage.

contentInfo ShipperContentInfo: Log content delivery format configuration.
shipperName string: Delivery configuration name, unique within a log project.
topicId string: Log topic ID.
kafkaShipperInfo ShipperKafkaShipperInfo: Kafka delivery configuration.
shipperEndTime number: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperStartTime number: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperType string: Type of data source for delivery. Options: tos, kafka. Default is tos.
status boolean: Whether to enable delivery configuration. Default is true.
tosShipperInfo ShipperTosShipperInfo: Information related to delivery to TOS object storage.

content_info ShipperContentInfoArgs: Log content delivery format configuration.
shipper_name str: Delivery configuration name, unique within a log project.
topic_id str: Log topic ID.
kafka_shipper_info ShipperKafkaShipperInfoArgs: Kafka delivery configuration.
shipper_end_time int: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipper_start_time int: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipper_type str: Type of data source for delivery. Options: tos, kafka. Default is tos.
status bool: Whether to enable delivery configuration. Default is true.
tos_shipper_info ShipperTosShipperInfoArgs: Information related to delivery to TOS object storage.

contentInfo Property Map: Log content delivery format configuration.
shipperName String: Delivery configuration name, unique within a log project.
topicId String: Log topic ID.
kafkaShipperInfo Property Map: Kafka delivery configuration.
shipperEndTime Number: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperStartTime Number: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperType String: Type of data source for delivery. Options: tos, kafka. Default is tos.
status Boolean: Whether to enable delivery configuration. Default is true.
tosShipperInfo Property Map: Information related to delivery to TOS object storage.

Outputs

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

CreatedTime string: Creation time.
DashboardId string: Default built-in dashboard ID for delivery.
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: Log project ID.
ProjectName string: Log project name.
ShipperId string: Delivery configuration ID.
TopicName string: Log topic name.
UpdatedTime string: Update time.

CreatedTime string: Creation time.
DashboardId string: Default built-in dashboard ID for delivery.
Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: Log project ID.
ProjectName string: Log project name.
ShipperId string: Delivery configuration ID.
TopicName string: Log topic name.
UpdatedTime string: Update time.

createdTime String: Creation time.
dashboardId String: Default built-in dashboard ID for delivery.
id String: The provider-assigned unique ID for this managed resource.
projectId String: Log project ID.
projectName String: Log project name.
shipperId String: Delivery configuration ID.
topicName String: Log topic name.
updatedTime String: Update time.

createdTime string: Creation time.
dashboardId string: Default built-in dashboard ID for delivery.
id string: The provider-assigned unique ID for this managed resource.
projectId string: Log project ID.
projectName string: Log project name.
shipperId string: Delivery configuration ID.
topicName string: Log topic name.
updatedTime string: Update time.

created_time str: Creation time.
dashboard_id str: Default built-in dashboard ID for delivery.
id str: The provider-assigned unique ID for this managed resource.
project_id str: Log project ID.
project_name str: Log project name.
shipper_id str: Delivery configuration ID.
topic_name str: Log topic name.
updated_time str: Update time.

createdTime String: Creation time.
dashboardId String: Default built-in dashboard ID for delivery.
id String: The provider-assigned unique ID for this managed resource.
projectId String: Log project ID.
projectName String: Log project name.
shipperId String: Delivery configuration ID.
topicName String: Log topic name.
updatedTime String: Update time.

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,
        created_time: Optional[str] = None,
        dashboard_id: Optional[str] = None,
        kafka_shipper_info: Optional[ShipperKafkaShipperInfoArgs] = None,
        project_id: Optional[str] = None,
        project_name: Optional[str] = None,
        shipper_end_time: Optional[int] = None,
        shipper_id: Optional[str] = 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,
        topic_name: Optional[str] = None,
        tos_shipper_info: Optional[ShipperTosShipperInfoArgs] = None,
        updated_time: Optional[str] = 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: volcenginecc: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 Volcengine.ShipperContentInfo: Log content delivery format configuration.
CreatedTime string: Creation time.
DashboardId string: Default built-in dashboard ID for delivery.
KafkaShipperInfo Volcengine.ShipperKafkaShipperInfo: Kafka delivery configuration.
ProjectId string: Log project ID.
ProjectName string: Log project name.
ShipperEndTime int: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
ShipperId string: Delivery configuration ID.
ShipperName string: Delivery configuration name, unique within a log project.
ShipperStartTime int: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
ShipperType string: Type of data source for delivery. Options: tos, kafka. Default is tos.
Status bool: Whether to enable delivery configuration. Default is true.
TopicId string: Log topic ID.
TopicName string: Log topic name.
TosShipperInfo Volcengine.ShipperTosShipperInfo: Information related to delivery to TOS object storage.
UpdatedTime string: Update time.

ContentInfo ShipperContentInfoArgs: Log content delivery format configuration.
CreatedTime string: Creation time.
DashboardId string: Default built-in dashboard ID for delivery.
KafkaShipperInfo ShipperKafkaShipperInfoArgs: Kafka delivery configuration.
ProjectId string: Log project ID.
ProjectName string: Log project name.
ShipperEndTime int: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
ShipperId string: Delivery configuration ID.
ShipperName string: Delivery configuration name, unique within a log project.
ShipperStartTime int: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
ShipperType string: Type of data source for delivery. Options: tos, kafka. Default is tos.
Status bool: Whether to enable delivery configuration. Default is true.
TopicId string: Log topic ID.
TopicName string: Log topic name.
TosShipperInfo ShipperTosShipperInfoArgs: Information related to delivery to TOS object storage.
UpdatedTime string: Update time.

contentInfo ShipperContentInfo: Log content delivery format configuration.
createdTime String: Creation time.
dashboardId String: Default built-in dashboard ID for delivery.
kafkaShipperInfo ShipperKafkaShipperInfo: Kafka delivery configuration.
projectId String: Log project ID.
projectName String: Log project name.
shipperEndTime Integer: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperId String: Delivery configuration ID.
shipperName String: Delivery configuration name, unique within a log project.
shipperStartTime Integer: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperType String: Type of data source for delivery. Options: tos, kafka. Default is tos.
status Boolean: Whether to enable delivery configuration. Default is true.
topicId String: Log topic ID.
topicName String: Log topic name.
tosShipperInfo ShipperTosShipperInfo: Information related to delivery to TOS object storage.
updatedTime String: Update time.

contentInfo ShipperContentInfo: Log content delivery format configuration.
createdTime string: Creation time.
dashboardId string: Default built-in dashboard ID for delivery.
kafkaShipperInfo ShipperKafkaShipperInfo: Kafka delivery configuration.
projectId string: Log project ID.
projectName string: Log project name.
shipperEndTime number: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperId string: Delivery configuration ID.
shipperName string: Delivery configuration name, unique within a log project.
shipperStartTime number: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperType string: Type of data source for delivery. Options: tos, kafka. Default is tos.
status boolean: Whether to enable delivery configuration. Default is true.
topicId string: Log topic ID.
topicName string: Log topic name.
tosShipperInfo ShipperTosShipperInfo: Information related to delivery to TOS object storage.
updatedTime string: Update time.

content_info ShipperContentInfoArgs: Log content delivery format configuration.
created_time str: Creation time.
dashboard_id str: Default built-in dashboard ID for delivery.
kafka_shipper_info ShipperKafkaShipperInfoArgs: Kafka delivery configuration.
project_id str: Log project ID.
project_name str: Log project name.
shipper_end_time int: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipper_id str: Delivery configuration ID.
shipper_name str: Delivery configuration name, unique within a log project.
shipper_start_time int: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipper_type str: Type of data source for delivery. Options: tos, kafka. Default is tos.
status bool: Whether to enable delivery configuration. Default is true.
topic_id str: Log topic ID.
topic_name str: Log topic name.
tos_shipper_info ShipperTosShipperInfoArgs: Information related to delivery to TOS object storage.
updated_time str: Update time.

contentInfo Property Map: Log content delivery format configuration.
createdTime String: Creation time.
dashboardId String: Default built-in dashboard ID for delivery.
kafkaShipperInfo Property Map: Kafka delivery configuration.
projectId String: Log project ID.
projectName String: Log project name.
shipperEndTime Number: Delivery end time, in milliseconds. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperId String: Delivery configuration ID.
shipperName String: Delivery configuration name, unique within a log project.
shipperStartTime Number: Delivery start time, in milliseconds. When delivering to Kafka, it is recommended to use the ShipperStartTime and ShipperEndTime fields to configure the delivery time range, and leave the StartTime and EndTime fields empty. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.
shipperType String: Type of data source for delivery. Options: tos, kafka. Default is tos.
status Boolean: Whether to enable delivery configuration. Default is true.
topicId String: Log topic ID.
topicName String: Log topic name.
tosShipperInfo Property Map: Information related to delivery to TOS object storage.
updatedTime String: Update time.

Supporting Types

ShipperContentInfo, ShipperContentInfoArgs

CsvInfo Volcengine.ShipperContentInfoCsvInfo: CSV format log content configuration.
Format string: Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.
JsonInfo Volcengine.ShipperContentInfoJsonInfo: JSON/JSONL format log content configuration.

CsvInfo ShipperContentInfoCsvInfo: CSV format log content configuration.
Format string: Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.
JsonInfo ShipperContentInfoJsonInfo: JSON/JSONL format log content configuration.

csvInfo ShipperContentInfoCsvInfo: CSV format log content configuration.
format String: Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.
jsonInfo ShipperContentInfoJsonInfo: JSON/JSONL format log content configuration.

csvInfo ShipperContentInfoCsvInfo: CSV format log content configuration.
format string: Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.
jsonInfo ShipperContentInfoJsonInfo: JSON/JSONL format log content configuration.

csv_info ShipperContentInfoCsvInfo: CSV format log content configuration.
format str: Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.
json_info ShipperContentInfoJsonInfo: JSON/JSONL format log content configuration.

csvInfo Property Map: CSV format log content configuration.
format String: Log content parsing format. Delivery to TOS supports json, jsonl, csv; delivery to Kafka supports original, json.
jsonInfo Property Map: JSON/JSONL format log content configuration.

ShipperContentInfoCsvInfo, ShipperContentInfoCsvInfoArgs

Delimiter string: Delimiter. Supports comma, tab, pipe, semicolon, space.
EscapeChar string: Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.
Keys List<string>: Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.
NonFieldContent string: Content for invalid field padding. Length: 0–128.
PrintHeader bool: Whether to print the key in the first row.

Delimiter string: Delimiter. Supports comma, tab, pipe, semicolon, space.
EscapeChar string: Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.
Keys []string: Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.
NonFieldContent string: Content for invalid field padding. Length: 0–128.
PrintHeader bool: Whether to print the key in the first row.

delimiter String: Delimiter. Supports comma, tab, pipe, semicolon, space.
escapeChar String: Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.
keys List<String>: Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.
nonFieldContent String: Content for invalid field padding. Length: 0–128.
printHeader Boolean: Whether to print the key in the first row.

delimiter string: Delimiter. Supports comma, tab, pipe, semicolon, space.
escapeChar string: Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.
keys string[]: Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.
nonFieldContent string: Content for invalid field padding. Length: 0–128.
printHeader boolean: Whether to print the key in the first row.

delimiter str: Delimiter. Supports comma, tab, pipe, semicolon, space.
escape_char str: Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.
keys Sequence[str]: Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.
non_field_content str: Content for invalid field padding. Length: 0–128.
print_header bool: Whether to print the key in the first row.

delimiter String: Delimiter. Supports comma, tab, pipe, semicolon, space.
escapeChar String: Escape character. When field content contains a delimiter, use an escape character to enclose it. Supports single quote, double quote, or empty character.
keys List<String>: Fields to be delivered. Supports letters, numbers, and _-./. Cannot start with an underscore. Length: 1–128.
nonFieldContent String: Content for invalid field padding. Length: 0–128.
printHeader Boolean: Whether to print the key in the first row.

ShipperContentInfoJsonInfo, ShipperContentInfoJsonInfoArgs

Enable bool: Enable flag.
Escape bool: Whether to enable escaping. Must be set to true.
Keys List<string>: Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including content (required), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag****client_ip, and tag****receive_time.

Enable bool: Enable flag.
Escape bool: Whether to enable escaping. Must be set to true.
Keys []string: Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including content (required), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag****client_ip, and tag****receive_time.

enable Boolean: Enable flag.
escape Boolean: Whether to enable escaping. Must be set to true.
keys List<String>: Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including content (required), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag****client_ip, and tag****receive_time.

enable boolean: Enable flag.
escape boolean: Whether to enable escaping. Must be set to true.
keys string[]: Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including content (required), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag****client_ip, and tag****receive_time.

enable bool: Enable flag.
escape bool: Whether to enable escaping. Must be set to true.
keys Sequence[str]: Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including content (required), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag****client_ip, and tag****receive_time.

enable Boolean: Enable flag.
escape Boolean: Whether to enable escaping. Must be set to true.
keys List<String>: Delivery field list; if not configured, all fields will be delivered. When delivering in JSON/JSONL format, if this parameter is not set, all fields will be delivered, including content (required), source, path, time, image_name, container_name, pod_name, pod_uid, namespace, tag****client_ip, and tag****receive_time.

ShipperKafkaShipperInfo, ShipperKafkaShipperInfoArgs

Compress string: Compression format; supports snappy, gzip, lz4, none.
EndTime int: Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.
Instance string: Kafka instance.
KafkaTopic string: Kafka topic name. All log data delivered through this configuration will be sent to this topic.
StartTime int: Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.

Compress string: Compression format; supports snappy, gzip, lz4, none.
EndTime int: Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.
Instance string: Kafka instance.
KafkaTopic string: Kafka topic name. All log data delivered through this configuration will be sent to this topic.
StartTime int: Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.

compress String: Compression format; supports snappy, gzip, lz4, none.
endTime Integer: Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.
instance String: Kafka instance.
kafkaTopic String: Kafka topic name. All log data delivered through this configuration will be sent to this topic.
startTime Integer: Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.

compress string: Compression format; supports snappy, gzip, lz4, none.
endTime number: Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.
instance string: Kafka instance.
kafkaTopic string: Kafka topic name. All log data delivered through this configuration will be sent to this topic.
startTime number: Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.

compress str: Compression format; supports snappy, gzip, lz4, none.
end_time int: Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.
instance str: Kafka instance.
kafka_topic str: Kafka topic name. All log data delivered through this configuration will be sent to this topic.
start_time int: Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.

compress String: Compression format; supports snappy, gzip, lz4, none.
endTime Number: Delivery end time, in milliseconds. If not set, delivery continues indefinitely. Note: Milliseconds will be truncated. For example, if 1776761323455 is entered, it will become 1776761323000; if 1776761323 is entered, it will become 1776761323000.
instance String: Kafka instance.
kafkaTopic String: Kafka topic name. All log data delivered through this configuration will be sent to this topic.
startTime Number: Start time. If not configured, defaults to the current time. Note: Millisecond data will be ignored. For example, if 1776761323455 is entered, the result will be 1776761323000; if 1776761323 is entered, the result will be 1776761323000.

ShipperTosShipperInfo, ShipperTosShipperInfoArgs

Bucket string: Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.
Compress string: Compression format; supports snappy, gzip, lz4, none.
Interval int: Delivery interval in seconds, range: 300–900.
MaxSize int: Maximum raw file size per partition for delivery, in MiB. Range: 5–256.
PartitionFormat string: Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.
Prefix string: Top-level directory name for the bucket. Cannot start with / or , and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.

Bucket string: Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.
Compress string: Compression format; supports snappy, gzip, lz4, none.
Interval int: Delivery interval in seconds, range: 300–900.
MaxSize int: Maximum raw file size per partition for delivery, in MiB. Range: 5–256.
PartitionFormat string: Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.
Prefix string: Top-level directory name for the bucket. Cannot start with / or , and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.

bucket String: Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.
compress String: Compression format; supports snappy, gzip, lz4, none.
interval Integer: Delivery interval in seconds, range: 300–900.
maxSize Integer: Maximum raw file size per partition for delivery, in MiB. Range: 5–256.
partitionFormat String: Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.
prefix String: Top-level directory name for the bucket. Cannot start with / or , and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.

bucket string: Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.
compress string: Compression format; supports snappy, gzip, lz4, none.
interval number: Delivery interval in seconds, range: 300–900.
maxSize number: Maximum raw file size per partition for delivery, in MiB. Range: 5–256.
partitionFormat string: Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.
prefix string: Top-level directory name for the bucket. Cannot start with / or , and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.

bucket str: Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.
compress str: Compression format; supports snappy, gzip, lz4, none.
interval int: Delivery interval in seconds, range: 300–900.
max_size int: Maximum raw file size per partition for delivery, in MiB. Range: 5–256.
partition_format str: Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.
prefix str: Top-level directory name for the bucket. Cannot start with / or , and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.

bucket String: Select a TOS bucket. Must be in the same region as the source log topic. Can only contain numbers, hyphens (-), and letters a–z. Must start and end with a number or letter. Length: 3–63 characters.
compress String: Compression format; supports snappy, gzip, lz4, none.
interval Number: Delivery interval in seconds, range: 300–900.
maxSize Number: Maximum raw file size per partition for delivery, in MiB. Range: 5–256.
partitionFormat String: Partition rule for log delivery. Subdirectory naming format supports strftime syntax. Default: %Y/%m/%d/%H/%M.
prefix String: Top-level directory name for the bucket. Cannot start with / or , and cannot use consecutive /. Cannot use .. as a folder name. Duplicate names are not allowed within the same bucket.

Import

$ pulumi import volcenginecc:tls/shipper:Shipper example "shipper_id"

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

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.tls.Shipper

On this page

On this page

Example Usage

Create Shipper Resource

Constructor syntax

Parameters

Shipper Resource Properties

Inputs

Outputs

Look up Existing Shipper Resource

Supporting Types

ShipperContentInfo, ShipperContentInfoArgs

ShipperContentInfoCsvInfo, ShipperContentInfoCsvInfoArgs

ShipperContentInfoJsonInfo, ShipperContentInfoJsonInfoArgs

ShipperKafkaShipperInfo, ShipperKafkaShipperInfoArgs

ShipperTosShipperInfo, ShipperTosShipperInfoArgs

Import

Package Details

On this page

On this page