volcenginecc.vefaas.getKafkaTrigger

Start a Neo task

Explain and create a volcenginecc.vefaas.getKafkaTrigger resource

volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

volcengine/pulumi-volcenginecc

Using getKafkaTrigger

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 getKafkaTrigger(args: GetKafkaTriggerArgs, opts?: InvokeOptions): Promise<GetKafkaTriggerResult>
function getKafkaTriggerOutput(args: GetKafkaTriggerOutputArgs, opts?: InvokeOptions): Output<GetKafkaTriggerResult>

def get_kafka_trigger(id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetKafkaTriggerResult
def get_kafka_trigger_output(id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetKafkaTriggerResult]

func LookupKafkaTrigger(ctx *Context, args *LookupKafkaTriggerArgs, opts ...InvokeOption) (*LookupKafkaTriggerResult, error)
func LookupKafkaTriggerOutput(ctx *Context, args *LookupKafkaTriggerOutputArgs, opts ...InvokeOption) LookupKafkaTriggerResultOutput

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

public static class GetKafkaTrigger 
{
    public static Task<GetKafkaTriggerResult> InvokeAsync(GetKafkaTriggerArgs args, InvokeOptions? opts = null)
    public static Output<GetKafkaTriggerResult> Invoke(GetKafkaTriggerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKafkaTriggerResult> getKafkaTrigger(GetKafkaTriggerArgs args, InvokeOptions options)
public static Output<GetKafkaTriggerResult> getKafkaTrigger(GetKafkaTriggerArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:vefaas/getKafkaTrigger:getKafkaTrigger
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getKafkaTrigger Result

The following output properties are available:

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。
Id string: Uniquely identifies the resource.
KafkaCredentials Volcengine.GetKafkaTriggerKafkaCredentials: 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。
Id string: Uniquely identifies the resource.
KafkaCredentials GetKafkaTriggerKafkaCredentials: 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。
id String: Uniquely identifies the resource.
kafkaCredentials GetKafkaTriggerKafkaCredentials: 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。
id string: Uniquely identifies the resource.
kafkaCredentials GetKafkaTriggerKafkaCredentials: 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。
id str: Uniquely identifies the resource.
kafka_credentials GetKafkaTriggerKafkaCredentials: 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。
id String: Uniquely identifies the resource.
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

GetKafkaTriggerKafkaCredentials

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 用户名称。

Package Details

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

volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

volcengine/pulumi-volcenginecc

volcenginecc.vefaas.getKafkaTrigger

On this page

On this page

Using getKafkaTrigger

getKafkaTrigger Result

Supporting Types

GetKafkaTriggerKafkaCredentials

Package Details

On this page

On this page