1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vefaas
  6. KafkaTrigger
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vefaas.KafkaTrigger

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Function service supports integration with Kafka message queue. By creating a Kafka trigger, the function service acts as a consumer to consume messages from Kafka and passes them to your function, triggering your function logic. You do not need to handle the details of message consumption; just write the function to process messages.

    Example Usage

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

const vefaasTriggerDemo = new volcenginecc.vefaas.KafkaTrigger("VefaasTriggerDemo", {
    functionId: "djb27tnr****",
    name: "VefaasTriggerDemo",
    maximumRetryAttempts: 74,
    startingPosition: "Earliest",
    enabled: false,
    kafkaCredentials: {
        mechanism: "PLAIN",
        username: "VefaasTriggerDemo",
        password: "*****",
    },
    mqInstanceId: "kafka-cnng8cm4q2fncrvs****",
    topicName: "VefaasTriggerDemo",
    description: "VefaasTriggerDemo description",
    batchFlushDurationMilliseconds: 8637,
    batchSize: 709,
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

vefaas_trigger_demo = volcenginecc.vefaas.KafkaTrigger("VefaasTriggerDemo",
    function_id="djb27tnr****",
    name="VefaasTriggerDemo",
    maximum_retry_attempts=74,
    starting_position="Earliest",
    enabled=False,
    kafka_credentials={
        "mechanism": "PLAIN",
        "username": "VefaasTriggerDemo",
        "password": "*****",
    },
    mq_instance_id="kafka-cnng8cm4q2fncrvs****",
    topic_name="VefaasTriggerDemo",
    description="VefaasTriggerDemo description",
    batch_flush_duration_milliseconds=8637,
    batch_size=709)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vefaas.NewKafkaTrigger(ctx, "VefaasTriggerDemo", &vefaas.KafkaTriggerArgs{
			FunctionId:           pulumi.String("djb27tnr****"),
			Name:                 pulumi.String("VefaasTriggerDemo"),
			MaximumRetryAttempts: pulumi.Int(74),
			StartingPosition:     pulumi.String("Earliest"),
			Enabled:              pulumi.Bool(false),
			KafkaCredentials: &vefaas.KafkaTriggerKafkaCredentialsArgs{
				Mechanism: pulumi.String("PLAIN"),
				Username:  pulumi.String("VefaasTriggerDemo"),
				Password:  pulumi.String("*****"),
			},
			MqInstanceId:                   pulumi.String("kafka-cnng8cm4q2fncrvs****"),
			TopicName:                      pulumi.String("VefaasTriggerDemo"),
			Description:                    pulumi.String("VefaasTriggerDemo description"),
			BatchFlushDurationMilliseconds: pulumi.Int(8637),
			BatchSize:                      pulumi.Int(709),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var vefaasTriggerDemo = new Volcenginecc.Vefaas.KafkaTrigger("VefaasTriggerDemo", new()
    {
        FunctionId = "djb27tnr****",
        Name = "VefaasTriggerDemo",
        MaximumRetryAttempts = 74,
        StartingPosition = "Earliest",
        Enabled = false,
        KafkaCredentials = new Volcenginecc.Vefaas.Inputs.KafkaTriggerKafkaCredentialsArgs
        {
            Mechanism = "PLAIN",
            Username = "VefaasTriggerDemo",
            Password = "*****",
        },
        MqInstanceId = "kafka-cnng8cm4q2fncrvs****",
        TopicName = "VefaasTriggerDemo",
        Description = "VefaasTriggerDemo description",
        BatchFlushDurationMilliseconds = 8637,
        BatchSize = 709,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.vefaas.KafkaTrigger;
import com.volcengine.volcenginecc.vefaas.KafkaTriggerArgs;
import com.pulumi.volcenginecc.vefaas.inputs.KafkaTriggerKafkaCredentialsArgs;
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 vefaasTriggerDemo = new KafkaTrigger("vefaasTriggerDemo", KafkaTriggerArgs.builder()
            .functionId("djb27tnr****")
            .name("VefaasTriggerDemo")
            .maximumRetryAttempts(74)
            .startingPosition("Earliest")
            .enabled(false)
            .kafkaCredentials(KafkaTriggerKafkaCredentialsArgs.builder()
                .mechanism("PLAIN")
                .username("VefaasTriggerDemo")
                .password("*****")
                .build())
            .mqInstanceId("kafka-cnng8cm4q2fncrvs****")
            .topicName("VefaasTriggerDemo")
            .description("VefaasTriggerDemo description")
            .batchFlushDurationMilliseconds(8637)
            .batchSize(709)
            .build());

    }
}

    resources:
  vefaasTriggerDemo:
    type: volcenginecc:vefaas:KafkaTrigger
    name: VefaasTriggerDemo
    properties:
      functionId: djb27tnr****
      name: VefaasTriggerDemo
      maximumRetryAttempts: 74
      startingPosition: Earliest
      enabled: false
      kafkaCredentials:
        mechanism: PLAIN
        username: VefaasTriggerDemo
        password: '*****'
      mqInstanceId: kafka-cnng8cm4q2fncrvs****
      topicName: VefaasTriggerDemo
      description: VefaasTriggerDemo description
      batchFlushDurationMilliseconds: 8637
      batchSize: 709

    Create KafkaTrigger Resource

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

    Constructor syntax

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

@overload
def KafkaTrigger(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 function_id: Optional[str] = None,
                 kafka_credentials: Optional[KafkaTriggerKafkaCredentialsArgs] = None,
                 mq_instance_id: Optional[str] = None,
                 name: Optional[str] = None,
                 topic_name: Optional[str] = None,
                 batch_flush_duration_milliseconds: Optional[int] = None,
                 batch_size: Optional[int] = None,
                 description: Optional[str] = None,
                 enabled: Optional[bool] = None,
                 maximum_retry_attempts: Optional[int] = None,
                 starting_position: Optional[str] = None)
    func NewKafkaTrigger(ctx *Context, name string, args KafkaTriggerArgs, opts ...ResourceOption) (*KafkaTrigger, error)
    public KafkaTrigger(string name, KafkaTriggerArgs args, CustomResourceOptions? opts = null)
    public KafkaTrigger(String name, KafkaTriggerArgs args)
public KafkaTrigger(String name, KafkaTriggerArgs args, CustomResourceOptions options)

    type: volcenginecc:vefaas:KafkaTrigger
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 KafkaTriggerArgs
    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 KafkaTriggerArgs
    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 KafkaTriggerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KafkaTriggerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KafkaTriggerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    FunctionId string
    Function ID.
    KafkaCredentials Volcengine.KafkaTriggerKafkaCredentials
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    MqInstanceId string
    Kafka message queue instance ID.
    Name string
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    TopicName string
    Topic name of the Kafka message queue instance.
    BatchFlushDurationMilliseconds int
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    BatchSize int
    Number of messages per batch for trigger batch consumption.
    Description string
    Description of the Kafka trigger. Limited to 200 characters.
    Enabled bool
    Enable the trigger when creating it. Options: true—enable. false—disable.
    MaximumRetryAttempts int
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    StartingPosition string
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    FunctionId string
    Function ID.
    KafkaCredentials KafkaTriggerKafkaCredentialsArgs
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    MqInstanceId string
    Kafka message queue instance ID.
    Name string
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    TopicName string
    Topic name of the Kafka message queue instance.
    BatchFlushDurationMilliseconds int
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    BatchSize int
    Number of messages per batch for trigger batch consumption.
    Description string
    Description of the Kafka trigger. Limited to 200 characters.
    Enabled bool
    Enable the trigger when creating it. Options: true—enable. false—disable.
    MaximumRetryAttempts int
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    StartingPosition string
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    functionId String
    Function ID.
    kafkaCredentials KafkaTriggerKafkaCredentials
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    mqInstanceId String
    Kafka message queue instance ID.
    name String
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    topicName String
    Topic name of the Kafka message queue instance.
    batchFlushDurationMilliseconds Integer
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    batchSize Integer
    Number of messages per batch for trigger batch consumption.
    description String
    Description of the Kafka trigger. Limited to 200 characters.
    enabled Boolean
    Enable the trigger when creating it. Options: true—enable. false—disable.
    maximumRetryAttempts Integer
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    startingPosition String
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    functionId string
    Function ID.
    kafkaCredentials KafkaTriggerKafkaCredentials
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    mqInstanceId string
    Kafka message queue instance ID.
    name string
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    topicName string
    Topic name of the Kafka message queue instance.
    batchFlushDurationMilliseconds number
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    batchSize number
    Number of messages per batch for trigger batch consumption.
    description string
    Description of the Kafka trigger. Limited to 200 characters.
    enabled boolean
    Enable the trigger when creating it. Options: true—enable. false—disable.
    maximumRetryAttempts number
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    startingPosition string
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    function_id str
    Function ID.
    kafka_credentials KafkaTriggerKafkaCredentialsArgs
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    mq_instance_id str
    Kafka message queue instance ID.
    name str
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    topic_name str
    Topic name of the Kafka message queue instance.
    batch_flush_duration_milliseconds int
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    batch_size int
    Number of messages per batch for trigger batch consumption.
    description str
    Description of the Kafka trigger. Limited to 200 characters.
    enabled bool
    Enable the trigger when creating it. Options: true—enable. false—disable.
    maximum_retry_attempts int
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    starting_position str
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    functionId String
    Function ID.
    kafkaCredentials Property Map
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    mqInstanceId String
    Kafka message queue instance ID.
    name String
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    topicName String
    Topic name of the Kafka message queue instance.
    batchFlushDurationMilliseconds Number
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    batchSize Number
    Number of messages per batch for trigger batch consumption.
    description String
    Description of the Kafka trigger. Limited to 200 characters.
    enabled Boolean
    Enable the trigger when creating it. Options: true—enable. false—disable.
    maximumRetryAttempts Number
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    startingPosition String
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.

    Outputs

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

    ConsumerGroup string
    Consumer group name of the Kafka message queue instance.
    CreatedTime string
    Kafka trigger creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaTriggerId string
    Kafka trigger ID.
    Status string
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    UpdatedTime string
    Last update time of the Kafka trigger.
    ConsumerGroup string
    Consumer group name of the Kafka message queue instance.
    CreatedTime string
    Kafka trigger creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaTriggerId string
    Kafka trigger ID.
    Status string
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    UpdatedTime string
    Last update time of the Kafka trigger.
    consumerGroup String
    Consumer group name of the Kafka message queue instance.
    createdTime String
    Kafka trigger creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaTriggerId String
    Kafka trigger ID.
    status String
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    updatedTime String
    Last update time of the Kafka trigger.
    consumerGroup string
    Consumer group name of the Kafka message queue instance.
    createdTime string
    Kafka trigger creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    kafkaTriggerId string
    Kafka trigger ID.
    status string
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    updatedTime string
    Last update time of the Kafka trigger.
    consumer_group str
    Consumer group name of the Kafka message queue instance.
    created_time str
    Kafka trigger creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    kafka_trigger_id str
    Kafka trigger ID.
    status str
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    updated_time str
    Last update time of the Kafka trigger.
    consumerGroup String
    Consumer group name of the Kafka message queue instance.
    createdTime String
    Kafka trigger creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaTriggerId String
    Kafka trigger ID.
    status String
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    updatedTime String
    Last update time of the Kafka trigger.

    Look up Existing KafkaTrigger Resource

    Get an existing KafkaTrigger 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?: KafkaTriggerState, opts?: CustomResourceOptions): KafkaTrigger
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        batch_flush_duration_milliseconds: Optional[int] = None,
        batch_size: Optional[int] = None,
        consumer_group: Optional[str] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        function_id: Optional[str] = None,
        kafka_credentials: Optional[KafkaTriggerKafkaCredentialsArgs] = None,
        kafka_trigger_id: Optional[str] = None,
        maximum_retry_attempts: Optional[int] = None,
        mq_instance_id: Optional[str] = None,
        name: Optional[str] = None,
        starting_position: Optional[str] = None,
        status: Optional[str] = None,
        topic_name: Optional[str] = None,
        updated_time: Optional[str] = None) -> KafkaTrigger
    func GetKafkaTrigger(ctx *Context, name string, id IDInput, state *KafkaTriggerState, opts ...ResourceOption) (*KafkaTrigger, error)
    public static KafkaTrigger Get(string name, Input<string> id, KafkaTriggerState? state, CustomResourceOptions? opts = null)
    public static KafkaTrigger get(String name, Output<String> id, KafkaTriggerState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:vefaas:KafkaTrigger    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:
    BatchFlushDurationMilliseconds int
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    BatchSize int
    Number of messages per batch for trigger batch consumption.
    ConsumerGroup string
    Consumer group name of the Kafka message queue instance.
    CreatedTime string
    Kafka trigger creation time.
    Description string
    Description of the Kafka trigger. Limited to 200 characters.
    Enabled bool
    Enable the trigger when creating it. Options: true—enable. false—disable.
    FunctionId string
    Function ID.
    KafkaCredentials Volcengine.KafkaTriggerKafkaCredentials
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    KafkaTriggerId string
    Kafka trigger ID.
    MaximumRetryAttempts int
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    MqInstanceId string
    Kafka message queue instance ID.
    Name string
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    StartingPosition string
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    Status string
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    TopicName string
    Topic name of the Kafka message queue instance.
    UpdatedTime string
    Last update time of the Kafka trigger.
    BatchFlushDurationMilliseconds int
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    BatchSize int
    Number of messages per batch for trigger batch consumption.
    ConsumerGroup string
    Consumer group name of the Kafka message queue instance.
    CreatedTime string
    Kafka trigger creation time.
    Description string
    Description of the Kafka trigger. Limited to 200 characters.
    Enabled bool
    Enable the trigger when creating it. Options: true—enable. false—disable.
    FunctionId string
    Function ID.
    KafkaCredentials KafkaTriggerKafkaCredentialsArgs
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    KafkaTriggerId string
    Kafka trigger ID.
    MaximumRetryAttempts int
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    MqInstanceId string
    Kafka message queue instance ID.
    Name string
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    StartingPosition string
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    Status string
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    TopicName string
    Topic name of the Kafka message queue instance.
    UpdatedTime string
    Last update time of the Kafka trigger.
    batchFlushDurationMilliseconds Integer
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    batchSize Integer
    Number of messages per batch for trigger batch consumption.
    consumerGroup String
    Consumer group name of the Kafka message queue instance.
    createdTime String
    Kafka trigger creation time.
    description String
    Description of the Kafka trigger. Limited to 200 characters.
    enabled Boolean
    Enable the trigger when creating it. Options: true—enable. false—disable.
    functionId String
    Function ID.
    kafkaCredentials KafkaTriggerKafkaCredentials
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    kafkaTriggerId String
    Kafka trigger ID.
    maximumRetryAttempts Integer
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    mqInstanceId String
    Kafka message queue instance ID.
    name String
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    startingPosition String
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    status String
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    topicName String
    Topic name of the Kafka message queue instance.
    updatedTime String
    Last update time of the Kafka trigger.
    batchFlushDurationMilliseconds number
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    batchSize number
    Number of messages per batch for trigger batch consumption.
    consumerGroup string
    Consumer group name of the Kafka message queue instance.
    createdTime string
    Kafka trigger creation time.
    description string
    Description of the Kafka trigger. Limited to 200 characters.
    enabled boolean
    Enable the trigger when creating it. Options: true—enable. false—disable.
    functionId string
    Function ID.
    kafkaCredentials KafkaTriggerKafkaCredentials
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    kafkaTriggerId string
    Kafka trigger ID.
    maximumRetryAttempts number
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    mqInstanceId string
    Kafka message queue instance ID.
    name string
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    startingPosition string
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    status string
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    topicName string
    Topic name of the Kafka message queue instance.
    updatedTime string
    Last update time of the Kafka trigger.
    batch_flush_duration_milliseconds int
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    batch_size int
    Number of messages per batch for trigger batch consumption.
    consumer_group str
    Consumer group name of the Kafka message queue instance.
    created_time str
    Kafka trigger creation time.
    description str
    Description of the Kafka trigger. Limited to 200 characters.
    enabled bool
    Enable the trigger when creating it. Options: true—enable. false—disable.
    function_id str
    Function ID.
    kafka_credentials KafkaTriggerKafkaCredentialsArgs
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    kafka_trigger_id str
    Kafka trigger ID.
    maximum_retry_attempts int
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    mq_instance_id str
    Kafka message queue instance ID.
    name str
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    starting_position str
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    status str
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    topic_name str
    Topic name of the Kafka message queue instance.
    updated_time str
    Last update time of the Kafka trigger.
    batchFlushDurationMilliseconds Number
    Maximum wait time for batch consumption by the trigger. Unit: milliseconds (ms). Valid range: 1000–60000 ms. Default: 1000 ms.
    batchSize Number
    Number of messages per batch for trigger batch consumption.
    consumerGroup String
    Consumer group name of the Kafka message queue instance.
    createdTime String
    Kafka trigger creation time.
    description String
    Description of the Kafka trigger. Limited to 200 characters.
    enabled Boolean
    Enable the trigger when creating it. Options: true—enable. false—disable.
    functionId String
    Function ID.
    kafkaCredentials Property Map
    Kafka identity authentication. Function service uses Kafka ACL permission policies to authenticate message consumption for SASL users of types PLAIN and SCRAM-SHA-256.
    kafkaTriggerId String
    Kafka trigger ID.
    maximumRetryAttempts Number
    Maximum number of retries when the function encounters a runtime error (including user code errors and runtime errors). Valid values: positive integers from 0 to 100.
    mqInstanceId String
    Kafka message queue instance ID.
    name String
    Kafka trigger name. Trigger names must be unique within the same function. Only uppercase and lowercase letters, numbers, and underscores are allowed, must start with a letter, and be 4–63 characters long.
    startingPosition String
    Specify the starting position for consuming messages in the Topic. Options: Latest—consume only messages produced after subscribing to the Topic. Earliest—consume from the first message produced in the Topic.
    status String
    Kafka trigger status. Parameter values: ready—running, failed—failed, pending—starting.
    topicName String
    Topic name of the Kafka message queue instance.
    updatedTime String
    Last update time of the Kafka trigger.

    Supporting Types

    KafkaTriggerKafkaCredentials, KafkaTriggerKafkaCredentialsArgs

    Mechanism string
    Kafka authentication mechanism. Options: PLAIN, SCRAM-SHA-256.
    Password string
    SASL/PLAIN password set when creating the Kafka instance.
    Username string
    SASL/PLAIN username set when creating the Kafka instance.
    Mechanism string
    Kafka authentication mechanism. Options: PLAIN, SCRAM-SHA-256.
    Password string
    SASL/PLAIN password set when creating the Kafka instance.
    Username string
    SASL/PLAIN username set when creating the Kafka instance.
    mechanism String
    Kafka authentication mechanism. Options: PLAIN, SCRAM-SHA-256.
    password String
    SASL/PLAIN password set when creating the Kafka instance.
    username String
    SASL/PLAIN username set when creating the Kafka instance.
    mechanism string
    Kafka authentication mechanism. Options: PLAIN, SCRAM-SHA-256.
    password string
    SASL/PLAIN password set when creating the Kafka instance.
    username string
    SASL/PLAIN username set when creating the Kafka instance.
    mechanism str
    Kafka authentication mechanism. Options: PLAIN, SCRAM-SHA-256.
    password str
    SASL/PLAIN password set when creating the Kafka instance.
    username str
    SASL/PLAIN username set when creating the Kafka instance.
    mechanism String
    Kafka authentication mechanism. Options: PLAIN, SCRAM-SHA-256.
    password String
    SASL/PLAIN password set when creating the Kafka instance.
    username String
    SASL/PLAIN username set when creating the Kafka instance.

    Import

    $ pulumi import volcenginecc:vefaas/kafkaTrigger:KafkaTrigger example "function_id|kafka_trigger_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.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.