volcenginecc.vefaas.getKafkaTrigger

volcenginecc v0.0.32, Apr 23 26

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

Schema (JSON)

volcengine/pulumi-volcenginecc

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

Schema (JSON)

volcengine/pulumi-volcenginecc

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

GetKafkaTriggerKafkaCredentials

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.