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

volcengine.tls.getShippers

Explore with Pulumi AI

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

    Use this data source to query detailed information of tls shippers

    Example Usage

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

const default = volcengine.tls.getShippers({});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tls.get_shippers()

    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.GetShippers(ctx, nil, nil)
		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 @default = Volcengine.Tls.GetShippers.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.TlsFunctions;
import com.pulumi.volcengine.tls.inputs.GetShippersArgs;
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) {
        final var default = TlsFunctions.getShippers();

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:tls:getShippers
      Arguments: {}

    Using getShippers

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getShippers(args: GetShippersArgs, opts?: InvokeOptions): Promise<GetShippersResult>
function getShippersOutput(args: GetShippersOutputArgs, opts?: InvokeOptions): Output<GetShippersResult>
    def get_shippers(iam_project_name: Optional[str] = None,
                 name_regex: Optional[str] = None,
                 output_file: Optional[str] = None,
                 project_id: Optional[str] = None,
                 project_name: Optional[str] = None,
                 shipper_id: Optional[str] = None,
                 shipper_name: Optional[str] = None,
                 shipper_type: Optional[str] = None,
                 topic_id: Optional[str] = None,
                 topic_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetShippersResult
def get_shippers_output(iam_project_name: Optional[pulumi.Input[str]] = None,
                 name_regex: Optional[pulumi.Input[str]] = None,
                 output_file: Optional[pulumi.Input[str]] = None,
                 project_id: Optional[pulumi.Input[str]] = None,
                 project_name: Optional[pulumi.Input[str]] = None,
                 shipper_id: Optional[pulumi.Input[str]] = None,
                 shipper_name: Optional[pulumi.Input[str]] = None,
                 shipper_type: Optional[pulumi.Input[str]] = None,
                 topic_id: Optional[pulumi.Input[str]] = None,
                 topic_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetShippersResult]
    func GetShippers(ctx *Context, args *GetShippersArgs, opts ...InvokeOption) (*GetShippersResult, error)
func GetShippersOutput(ctx *Context, args *GetShippersOutputArgs, opts ...InvokeOption) GetShippersResultOutput

    > Note: This function is named GetShippers in the Go SDK.

    public static class GetShippers 
{
    public static Task<GetShippersResult> InvokeAsync(GetShippersArgs args, InvokeOptions? opts = null)
    public static Output<GetShippersResult> Invoke(GetShippersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetShippersResult> getShippers(GetShippersArgs args, InvokeOptions options)
public static Output<GetShippersResult> getShippers(GetShippersArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:tls/getShippers:getShippers
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IamProjectName string
    Specify the IAM project name for querying the data delivery configuration under the specified IAM project.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectId string
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    ProjectName string
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    ShipperId string
    Delivery configuration ID.
    ShipperName string
    Delivery configuration name.
    ShipperType string
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    TopicId string
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    TopicName string
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    IamProjectName string
    Specify the IAM project name for querying the data delivery configuration under the specified IAM project.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    ProjectId string
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    ProjectName string
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    ShipperId string
    Delivery configuration ID.
    ShipperName string
    Delivery configuration name.
    ShipperType string
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    TopicId string
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    TopicName string
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    iamProjectName String
    Specify the IAM project name for querying the data delivery configuration under the specified IAM project.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectId String
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    projectName String
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    shipperId String
    Delivery configuration ID.
    shipperName String
    Delivery configuration name.
    shipperType String
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    topicId String
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    topicName String
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    iamProjectName string
    Specify the IAM project name for querying the data delivery configuration under the specified IAM project.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    projectId string
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    projectName string
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    shipperId string
    Delivery configuration ID.
    shipperName string
    Delivery configuration name.
    shipperType string
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    topicId string
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    topicName string
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    iam_project_name str
    Specify the IAM project name for querying the data delivery configuration under the specified IAM project.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    project_id str
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    project_name str
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    shipper_id str
    Delivery configuration ID.
    shipper_name str
    Delivery configuration name.
    shipper_type str
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    topic_id str
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    topic_name str
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    iamProjectName String
    Specify the IAM project name for querying the data delivery configuration under the specified IAM project.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    projectId String
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    projectName String
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    shipperId String
    Delivery configuration ID.
    shipperName String
    Delivery configuration name.
    shipperType String
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    topicId String
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    topicName String
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.

    getShippers Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Shippers List<GetShippersShipper>
    Submit the relevant information of the configuration.
    TotalCount int
    The total count of query.
    IamProjectName string
    NameRegex string
    OutputFile string
    ProjectId string
    The log project ID where the log to be delivered is located.
    ProjectName string
    The name of the log item where the log to be delivered is located.
    ShipperId string
    Deliver configuration ID.
    ShipperName string
    Delivery configuration name.
    ShipperType string
    The type of delivery.
    TopicId string
    The log topic ID where the log to be delivered is located.
    TopicName string
    The name of the log topic where the log to be delivered is located.
    Id string
    The provider-assigned unique ID for this managed resource.
    Shippers []GetShippersShipper
    Submit the relevant information of the configuration.
    TotalCount int
    The total count of query.
    IamProjectName string
    NameRegex string
    OutputFile string
    ProjectId string
    The log project ID where the log to be delivered is located.
    ProjectName string
    The name of the log item where the log to be delivered is located.
    ShipperId string
    Deliver configuration ID.
    ShipperName string
    Delivery configuration name.
    ShipperType string
    The type of delivery.
    TopicId string
    The log topic ID where the log to be delivered is located.
    TopicName string
    The name of the log topic where the log to be delivered is located.
    id String
    The provider-assigned unique ID for this managed resource.
    shippers List<GetShippersShipper>
    Submit the relevant information of the configuration.
    totalCount Integer
    The total count of query.
    iamProjectName String
    nameRegex String
    outputFile String
    projectId String
    The log project ID where the log to be delivered is located.
    projectName String
    The name of the log item where the log to be delivered is located.
    shipperId String
    Deliver configuration ID.
    shipperName String
    Delivery configuration name.
    shipperType String
    The type of delivery.
    topicId String
    The log topic ID where the log to be delivered is located.
    topicName String
    The name of the log topic where the log to be delivered is located.
    id string
    The provider-assigned unique ID for this managed resource.
    shippers GetShippersShipper[]
    Submit the relevant information of the configuration.
    totalCount number
    The total count of query.
    iamProjectName string
    nameRegex string
    outputFile string
    projectId string
    The log project ID where the log to be delivered is located.
    projectName string
    The name of the log item where the log to be delivered is located.
    shipperId string
    Deliver configuration ID.
    shipperName string
    Delivery configuration name.
    shipperType string
    The type of delivery.
    topicId string
    The log topic ID where the log to be delivered is located.
    topicName string
    The name of the log topic where the log to be delivered is located.
    id str
    The provider-assigned unique ID for this managed resource.
    shippers Sequence[GetShippersShipper]
    Submit the relevant information of the configuration.
    total_count int
    The total count of query.
    iam_project_name str
    name_regex str
    output_file str
    project_id str
    The log project ID where the log to be delivered is located.
    project_name str
    The name of the log item where the log to be delivered is located.
    shipper_id str
    Deliver configuration ID.
    shipper_name str
    Delivery configuration name.
    shipper_type str
    The type of delivery.
    topic_id str
    The log topic ID where the log to be delivered is located.
    topic_name str
    The name of the log topic where the log to be delivered is located.
    id String
    The provider-assigned unique ID for this managed resource.
    shippers List<Property Map>
    Submit the relevant information of the configuration.
    totalCount Number
    The total count of query.
    iamProjectName String
    nameRegex String
    outputFile String
    projectId String
    The log project ID where the log to be delivered is located.
    projectName String
    The name of the log item where the log to be delivered is located.
    shipperId String
    Deliver configuration ID.
    shipperName String
    Delivery configuration name.
    shipperType String
    The type of delivery.
    topicId String
    The log topic ID where the log to be delivered is located.
    topicName String
    The name of the log topic where the log to be delivered is located.

    Supporting Types

    GetShippersShipper

    ContentInfo GetShippersShipperContentInfo
    The content format configuration of the delivery log.
    CreateTime string
    Processing task creation time.
    DashboardId string
    The default built-in dashboard ID for delivery.
    KafkaShipperInfo GetShippersShipperKafkaShipperInfo
    JSON format log content configuration.
    ModifyTime string
    The most recent modification time of the processing task.
    ProjectId string
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    ProjectName string
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    ShipperEndTime int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    ShipperId string
    Delivery configuration ID.
    ShipperName string
    Delivery configuration name.
    ShipperStartTime int
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time.
    ShipperType string
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    Status bool
    Whether to enable the delivery configuration.
    TopicId string
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    TopicName string
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    TosShipperInfo GetShippersShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    ContentInfo GetShippersShipperContentInfo
    The content format configuration of the delivery log.
    CreateTime string
    Processing task creation time.
    DashboardId string
    The default built-in dashboard ID for delivery.
    KafkaShipperInfo GetShippersShipperKafkaShipperInfo
    JSON format log content configuration.
    ModifyTime string
    The most recent modification time of the processing task.
    ProjectId string
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    ProjectName string
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    ShipperEndTime int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    ShipperId string
    Delivery configuration ID.
    ShipperName string
    Delivery configuration name.
    ShipperStartTime int
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time.
    ShipperType string
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    Status bool
    Whether to enable the delivery configuration.
    TopicId string
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    TopicName string
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    TosShipperInfo GetShippersShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    contentInfo GetShippersShipperContentInfo
    The content format configuration of the delivery log.
    createTime String
    Processing task creation time.
    dashboardId String
    The default built-in dashboard ID for delivery.
    kafkaShipperInfo GetShippersShipperKafkaShipperInfo
    JSON format log content configuration.
    modifyTime String
    The most recent modification time of the processing task.
    projectId String
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    projectName String
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    shipperEndTime Integer
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    shipperId String
    Delivery configuration ID.
    shipperName String
    Delivery configuration name.
    shipperStartTime Integer
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time.
    shipperType String
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    status Boolean
    Whether to enable the delivery configuration.
    topicId String
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    topicName String
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    tosShipperInfo GetShippersShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    contentInfo GetShippersShipperContentInfo
    The content format configuration of the delivery log.
    createTime string
    Processing task creation time.
    dashboardId string
    The default built-in dashboard ID for delivery.
    kafkaShipperInfo GetShippersShipperKafkaShipperInfo
    JSON format log content configuration.
    modifyTime string
    The most recent modification time of the processing task.
    projectId string
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    projectName string
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    shipperEndTime number
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    shipperId string
    Delivery configuration ID.
    shipperName string
    Delivery configuration name.
    shipperStartTime number
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time.
    shipperType string
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    status boolean
    Whether to enable the delivery configuration.
    topicId string
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    topicName string
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    tosShipperInfo GetShippersShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    content_info GetShippersShipperContentInfo
    The content format configuration of the delivery log.
    create_time str
    Processing task creation time.
    dashboard_id str
    The default built-in dashboard ID for delivery.
    kafka_shipper_info GetShippersShipperKafkaShipperInfo
    JSON format log content configuration.
    modify_time str
    The most recent modification time of the processing task.
    project_id str
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    project_name str
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    shipper_end_time int
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    shipper_id str
    Delivery configuration ID.
    shipper_name str
    Delivery configuration name.
    shipper_start_time int
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time.
    shipper_type str
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    status bool
    Whether to enable the delivery configuration.
    topic_id str
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    topic_name str
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    tos_shipper_info GetShippersShipperTosShipperInfo
    Deliver the relevant configuration to the object storage (TOS).
    contentInfo Property Map
    The content format configuration of the delivery log.
    createTime String
    Processing task creation time.
    dashboardId String
    The default built-in dashboard ID for delivery.
    kafkaShipperInfo Property Map
    JSON format log content configuration.
    modifyTime String
    The most recent modification time of the processing task.
    projectId String
    Specify the log item ID for querying the data delivery configuration under the specified log item.
    projectName String
    Specify the name of the log item for querying the data delivery configuration under the specified log item. Support fuzzy matching.
    shipperEndTime Number
    Delivery end time, millisecond timestamp. If not configured, it will keep delivering.
    shipperId String
    Delivery configuration ID.
    shipperName String
    Delivery configuration name.
    shipperStartTime Number
    Delivery start time, millisecond timestamp. If not configured, it defaults to the current time.
    shipperType String
    Specify the delivery type for querying the delivery configuration related to that delivery type.
    status Boolean
    Whether to enable the delivery configuration.
    topicId String
    Specify the log topic ID for querying the data delivery configuration related to this log topic.
    topicName String
    Specify the name of the log topic for querying the data delivery configuration related to this log topic. Support fuzzy matching.
    tosShipperInfo Property Map
    Deliver the relevant configuration to the object storage (TOS).

    GetShippersShipperContentInfo

    CsvInfo GetShippersShipperContentInfoCsvInfo
    CSV format log content configuration.
    Format string
    Log content parsing format.
    JsonInfo GetShippersShipperContentInfoJsonInfo
    JSON format log content configuration.
    CsvInfo GetShippersShipperContentInfoCsvInfo
    CSV format log content configuration.
    Format string
    Log content parsing format.
    JsonInfo GetShippersShipperContentInfoJsonInfo
    JSON format log content configuration.
    csvInfo GetShippersShipperContentInfoCsvInfo
    CSV format log content configuration.
    format String
    Log content parsing format.
    jsonInfo GetShippersShipperContentInfoJsonInfo
    JSON format log content configuration.
    csvInfo GetShippersShipperContentInfoCsvInfo
    CSV format log content configuration.
    format string
    Log content parsing format.
    jsonInfo GetShippersShipperContentInfoJsonInfo
    JSON format log content configuration.
    csv_info GetShippersShipperContentInfoCsvInfo
    CSV format log content configuration.
    format str
    Log content parsing format.
    json_info GetShippersShipperContentInfoJsonInfo
    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.

    GetShippersShipperContentInfoCsvInfo

    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>
    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.
    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
    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.
    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>
    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.
    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[]
    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.
    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]
    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.
    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>
    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.
    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.

    GetShippersShipperContentInfoJsonInfo

    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.

    GetShippersShipperKafkaShipperInfo

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

    GetShippersShipperTosShipperInfo

    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.

    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