1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. vefaas
  5. KafkaTrigger
volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine
volcengine/pulumi-volcenginecc

volcenginecc.vefaas.KafkaTrigger

Start a Neo task
Explain and create a volcenginecc.vefaas.KafkaTrigger resource
volcenginecc logo
volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine
volcengine/pulumi-volcenginecc

    函数服务支持对接消息队列 Kafka 版。通过创建 Kafka 触发器，函数服务将作为消费者消费 Kafka 中的消息，并将消息传递给用户函数，触发函数代码逻辑。您无需关心函数服务消费消息的细节，只需编写处理消息的函数。

    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.

    Constructor example

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

    var kafkaTriggerResource = new Volcenginecc.Vefaas.KafkaTrigger("kafkaTriggerResource", new()
{
    FunctionId = "string",
    KafkaCredentials = new Volcenginecc.Vefaas.Inputs.KafkaTriggerKafkaCredentialsArgs
    {
        Mechanism = "string",
        Password = "string",
        Username = "string",
    },
    MqInstanceId = "string",
    Name = "string",
    TopicName = "string",
    BatchFlushDurationMilliseconds = 0,
    BatchSize = 0,
    Description = "string",
    Enabled = false,
    MaximumRetryAttempts = 0,
    StartingPosition = "string",
});

    example, err := vefaas.NewKafkaTrigger(ctx, "kafkaTriggerResource", &vefaas.KafkaTriggerArgs{
	FunctionId: pulumi.String("string"),
	KafkaCredentials: &vefaas.KafkaTriggerKafkaCredentialsArgs{
		Mechanism: pulumi.String("string"),
		Password:  pulumi.String("string"),
		Username:  pulumi.String("string"),
	},
	MqInstanceId:                   pulumi.String("string"),
	Name:                           pulumi.String("string"),
	TopicName:                      pulumi.String("string"),
	BatchFlushDurationMilliseconds: pulumi.Int(0),
	BatchSize:                      pulumi.Int(0),
	Description:                    pulumi.String("string"),
	Enabled:                        pulumi.Bool(false),
	MaximumRetryAttempts:           pulumi.Int(0),
	StartingPosition:               pulumi.String("string"),
})

    var kafkaTriggerResource = new KafkaTrigger("kafkaTriggerResource", KafkaTriggerArgs.builder()
    .functionId("string")
    .kafkaCredentials(KafkaTriggerKafkaCredentialsArgs.builder()
        .mechanism("string")
        .password("string")
        .username("string")
        .build())
    .mqInstanceId("string")
    .name("string")
    .topicName("string")
    .batchFlushDurationMilliseconds(0)
    .batchSize(0)
    .description("string")
    .enabled(false)
    .maximumRetryAttempts(0)
    .startingPosition("string")
    .build());

    kafka_trigger_resource = volcenginecc.vefaas.KafkaTrigger("kafkaTriggerResource",
    function_id="string",
    kafka_credentials={
        "mechanism": "string",
        "password": "string",
        "username": "string",
    },
    mq_instance_id="string",
    name="string",
    topic_name="string",
    batch_flush_duration_milliseconds=0,
    batch_size=0,
    description="string",
    enabled=False,
    maximum_retry_attempts=0,
    starting_position="string")

    const kafkaTriggerResource = new volcenginecc.vefaas.KafkaTrigger("kafkaTriggerResource", {
    functionId: "string",
    kafkaCredentials: {
        mechanism: "string",
        password: "string",
        username: "string",
    },
    mqInstanceId: "string",
    name: "string",
    topicName: "string",
    batchFlushDurationMilliseconds: 0,
    batchSize: 0,
    description: "string",
    enabled: false,
    maximumRetryAttempts: 0,
    startingPosition: "string",
});

    type: volcenginecc:vefaas:KafkaTrigger
properties:
    batchFlushDurationMilliseconds: 0
    batchSize: 0
    description: string
    enabled: false
    functionId: string
    kafkaCredentials:
        mechanism: string
        password: string
        username: string
    maximumRetryAttempts: 0
    mqInstanceId: string
    name: string
    startingPosition: string
    topicName: string

    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
    函数 ID。
    KafkaCredentials Volcengine.KafkaTriggerKafkaCredentials
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    MqInstanceId string
    消息队列 Kafka 实例 ID。
    Name string
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    TopicName string
    消息队列 Kafka 实例的 Topic 名称。
    BatchFlushDurationMilliseconds int
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    BatchSize int
    触发器批量消费的每批次消息数。
    Description string
    Kafka 触发器描述。长度限制为 200 个字符以内。
    Enabled bool
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    MaximumRetryAttempts int
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    StartingPosition string
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    FunctionId string
    函数 ID。
    KafkaCredentials KafkaTriggerKafkaCredentialsArgs
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    MqInstanceId string
    消息队列 Kafka 实例 ID。
    Name string
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    TopicName string
    消息队列 Kafka 实例的 Topic 名称。
    BatchFlushDurationMilliseconds int
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    BatchSize int
    触发器批量消费的每批次消息数。
    Description string
    Kafka 触发器描述。长度限制为 200 个字符以内。
    Enabled bool
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    MaximumRetryAttempts int
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    StartingPosition string
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    functionId String
    函数 ID。
    kafkaCredentials KafkaTriggerKafkaCredentials
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    mqInstanceId String
    消息队列 Kafka 实例 ID。
    name String
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    topicName String
    消息队列 Kafka 实例的 Topic 名称。
    batchFlushDurationMilliseconds Integer
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    batchSize Integer
    触发器批量消费的每批次消息数。
    description String
    Kafka 触发器描述。长度限制为 200 个字符以内。
    enabled Boolean
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    maximumRetryAttempts Integer
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    startingPosition String
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    functionId string
    函数 ID。
    kafkaCredentials KafkaTriggerKafkaCredentials
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    mqInstanceId string
    消息队列 Kafka 实例 ID。
    name string
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    topicName string
    消息队列 Kafka 实例的 Topic 名称。
    batchFlushDurationMilliseconds number
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    batchSize number
    触发器批量消费的每批次消息数。
    description string
    Kafka 触发器描述。长度限制为 200 个字符以内。
    enabled boolean
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    maximumRetryAttempts number
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    startingPosition string
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    function_id str
    函数 ID。
    kafka_credentials KafkaTriggerKafkaCredentialsArgs
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    mq_instance_id str
    消息队列 Kafka 实例 ID。
    name str
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    topic_name str
    消息队列 Kafka 实例的 Topic 名称。
    batch_flush_duration_milliseconds int
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    batch_size int
    触发器批量消费的每批次消息数。
    description str
    Kafka 触发器描述。长度限制为 200 个字符以内。
    enabled bool
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    maximum_retry_attempts int
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    starting_position str
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    functionId String
    函数 ID。
    kafkaCredentials Property Map
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    mqInstanceId String
    消息队列 Kafka 实例 ID。
    name String
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    topicName String
    消息队列 Kafka 实例的 Topic 名称。
    batchFlushDurationMilliseconds Number
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    batchSize Number
    触发器批量消费的每批次消息数。
    description String
    Kafka 触发器描述。长度限制为 200 个字符以内。
    enabled Boolean
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    maximumRetryAttempts Number
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    startingPosition String
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。

    Outputs

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

    ConsumerGroup string
    消息队列 Kafka 实例的消费组名字。
    CreatedTime string
    Kafka 触发器创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaTriggerId string
    Kafka 触发器 ID。
    Status string
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    UpdatedTime string
    Kafka 触发器最近一次更新时间。
    ConsumerGroup string
    消息队列 Kafka 实例的消费组名字。
    CreatedTime string
    Kafka 触发器创建时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaTriggerId string
    Kafka 触发器 ID。
    Status string
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    UpdatedTime string
    Kafka 触发器最近一次更新时间。
    consumerGroup String
    消息队列 Kafka 实例的消费组名字。
    createdTime String
    Kafka 触发器创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaTriggerId String
    Kafka 触发器 ID。
    status String
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    updatedTime String
    Kafka 触发器最近一次更新时间。
    consumerGroup string
    消息队列 Kafka 实例的消费组名字。
    createdTime string
    Kafka 触发器创建时间。
    id string
    The provider-assigned unique ID for this managed resource.
    kafkaTriggerId string
    Kafka 触发器 ID。
    status string
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    updatedTime string
    Kafka 触发器最近一次更新时间。
    consumer_group str
    消息队列 Kafka 实例的消费组名字。
    created_time str
    Kafka 触发器创建时间。
    id str
    The provider-assigned unique ID for this managed resource.
    kafka_trigger_id str
    Kafka 触发器 ID。
    status str
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    updated_time str
    Kafka 触发器最近一次更新时间。
    consumerGroup String
    消息队列 Kafka 实例的消费组名字。
    createdTime String
    Kafka 触发器创建时间。
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaTriggerId String
    Kafka 触发器 ID。
    status String
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    updatedTime String
    Kafka 触发器最近一次更新时间。

    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
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    BatchSize int
    触发器批量消费的每批次消息数。
    ConsumerGroup string
    消息队列 Kafka 实例的消费组名字。
    CreatedTime string
    Kafka 触发器创建时间。
    Description string
    Kafka 触发器描述。长度限制为 200 个字符以内。
    Enabled bool
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    FunctionId string
    函数 ID。
    KafkaCredentials Volcengine.KafkaTriggerKafkaCredentials
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    KafkaTriggerId string
    Kafka 触发器 ID。
    MaximumRetryAttempts int
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    MqInstanceId string
    消息队列 Kafka 实例 ID。
    Name string
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    StartingPosition string
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    Status string
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    TopicName string
    消息队列 Kafka 实例的 Topic 名称。
    UpdatedTime string
    Kafka 触发器最近一次更新时间。
    BatchFlushDurationMilliseconds int
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    BatchSize int
    触发器批量消费的每批次消息数。
    ConsumerGroup string
    消息队列 Kafka 实例的消费组名字。
    CreatedTime string
    Kafka 触发器创建时间。
    Description string
    Kafka 触发器描述。长度限制为 200 个字符以内。
    Enabled bool
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    FunctionId string
    函数 ID。
    KafkaCredentials KafkaTriggerKafkaCredentialsArgs
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    KafkaTriggerId string
    Kafka 触发器 ID。
    MaximumRetryAttempts int
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    MqInstanceId string
    消息队列 Kafka 实例 ID。
    Name string
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    StartingPosition string
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    Status string
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    TopicName string
    消息队列 Kafka 实例的 Topic 名称。
    UpdatedTime string
    Kafka 触发器最近一次更新时间。
    batchFlushDurationMilliseconds Integer
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    batchSize Integer
    触发器批量消费的每批次消息数。
    consumerGroup String
    消息队列 Kafka 实例的消费组名字。
    createdTime String
    Kafka 触发器创建时间。
    description String
    Kafka 触发器描述。长度限制为 200 个字符以内。
    enabled Boolean
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    functionId String
    函数 ID。
    kafkaCredentials KafkaTriggerKafkaCredentials
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    kafkaTriggerId String
    Kafka 触发器 ID。
    maximumRetryAttempts Integer
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    mqInstanceId String
    消息队列 Kafka 实例 ID。
    name String
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    startingPosition String
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    status String
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    topicName String
    消息队列 Kafka 实例的 Topic 名称。
    updatedTime String
    Kafka 触发器最近一次更新时间。
    batchFlushDurationMilliseconds number
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    batchSize number
    触发器批量消费的每批次消息数。
    consumerGroup string
    消息队列 Kafka 实例的消费组名字。
    createdTime string
    Kafka 触发器创建时间。
    description string
    Kafka 触发器描述。长度限制为 200 个字符以内。
    enabled boolean
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    functionId string
    函数 ID。
    kafkaCredentials KafkaTriggerKafkaCredentials
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    kafkaTriggerId string
    Kafka 触发器 ID。
    maximumRetryAttempts number
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    mqInstanceId string
    消息队列 Kafka 实例 ID。
    name string
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    startingPosition string
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    status string
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    topicName string
    消息队列 Kafka 实例的 Topic 名称。
    updatedTime string
    Kafka 触发器最近一次更新时间。
    batch_flush_duration_milliseconds int
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    batch_size int
    触发器批量消费的每批次消息数。
    consumer_group str
    消息队列 Kafka 实例的消费组名字。
    created_time str
    Kafka 触发器创建时间。
    description str
    Kafka 触发器描述。长度限制为 200 个字符以内。
    enabled bool
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    function_id str
    函数 ID。
    kafka_credentials KafkaTriggerKafkaCredentialsArgs
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    kafka_trigger_id str
    Kafka 触发器 ID。
    maximum_retry_attempts int
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    mq_instance_id str
    消息队列 Kafka 实例 ID。
    name str
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    starting_position str
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    status str
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    topic_name str
    消息队列 Kafka 实例的 Topic 名称。
    updated_time str
    Kafka 触发器最近一次更新时间。
    batchFlushDurationMilliseconds Number
    触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。
    batchSize Number
    触发器批量消费的每批次消息数。
    consumerGroup String
    消息队列 Kafka 实例的消费组名字。
    createdTime String
    Kafka 触发器创建时间。
    description String
    Kafka 触发器描述。长度限制为 200 个字符以内。
    enabled Boolean
    是否在创建触发器的同时启用触发器。取值：true：启用。false：关闭。
    functionId String
    函数 ID。
    kafkaCredentials Property Map
    Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。
    kafkaTriggerId String
    Kafka 触发器 ID。
    maximumRetryAttempts Number
    函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
    mqInstanceId String
    消息队列 Kafka 实例 ID。
    name String
    Kafka 触发器名字。同一函数下，触发器名称不可重复。只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
    startingPosition String
    指定开始消费 Topic 中消息的位置。取值：Latest：只消费订阅 Topic 后产生的消息。Earliest：从 Topic 中生产的第一条消息开始消费。
    status String
    Kafka 触发器状态。参数值说明：ready：运行，failed：失败，pending：启动中
    topicName String
    消息队列 Kafka 实例的 Topic 名称。
    updatedTime String
    Kafka 触发器最近一次更新时间。

    Supporting Types

    KafkaTriggerKafkaCredentials, KafkaTriggerKafkaCredentialsArgs

    Mechanism string
    Kafka 认证机制。取值：PLAIN，SCRAM-SHA-256。
    Password string
    创建 Kafka 实例时设置的 SASL/PLAIN 用户密码。
    Username string
    创建 Kafka 实例时设置的 SASL/PLAIN 用户名称。
    Mechanism string
    Kafka 认证机制。取值：PLAIN，SCRAM-SHA-256。
    Password string
    创建 Kafka 实例时设置的 SASL/PLAIN 用户密码。
    Username string
    创建 Kafka 实例时设置的 SASL/PLAIN 用户名称。
    mechanism String
    Kafka 认证机制。取值：PLAIN，SCRAM-SHA-256。
    password String
    创建 Kafka 实例时设置的 SASL/PLAIN 用户密码。
    username String
    创建 Kafka 实例时设置的 SASL/PLAIN 用户名称。
    mechanism string
    Kafka 认证机制。取值：PLAIN，SCRAM-SHA-256。
    password string
    创建 Kafka 实例时设置的 SASL/PLAIN 用户密码。
    username string
    创建 Kafka 实例时设置的 SASL/PLAIN 用户名称。
    mechanism str
    Kafka 认证机制。取值：PLAIN，SCRAM-SHA-256。
    password str
    创建 Kafka 实例时设置的 SASL/PLAIN 用户密码。
    username str
    创建 Kafka 实例时设置的 SASL/PLAIN 用户名称。
    mechanism String
    Kafka 认证机制。取值：PLAIN，SCRAM-SHA-256。
    password String
    创建 Kafka 实例时设置的 SASL/PLAIN 用户密码。
    username String
    创建 Kafka 实例时设置的 SASL/PLAIN 用户名称。

    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
    volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine
    volcengine/pulumi-volcenginecc
      Meet Neo: Your AI Platform Teammate