1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginConfluentConsume
konnect 2.7.3 published on Tuesday, May 13, 2025 by kong

konnect.getGatewayPluginConfluentConsume

Explore with Pulumi AI

konnect logo
konnect 2.7.3 published on Tuesday, May 13, 2025 by kong

    Using getGatewayPluginConfluentConsume

    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 getGatewayPluginConfluentConsume(args: GetGatewayPluginConfluentConsumeArgs, opts?: InvokeOptions): Promise<GetGatewayPluginConfluentConsumeResult>
    function getGatewayPluginConfluentConsumeOutput(args: GetGatewayPluginConfluentConsumeOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginConfluentConsumeResult>
    def get_gateway_plugin_confluent_consume(control_plane_id: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetGatewayPluginConfluentConsumeResult
    def get_gateway_plugin_confluent_consume_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginConfluentConsumeResult]
    func LookupGatewayPluginConfluentConsume(ctx *Context, args *LookupGatewayPluginConfluentConsumeArgs, opts ...InvokeOption) (*LookupGatewayPluginConfluentConsumeResult, error)
    func LookupGatewayPluginConfluentConsumeOutput(ctx *Context, args *LookupGatewayPluginConfluentConsumeOutputArgs, opts ...InvokeOption) LookupGatewayPluginConfluentConsumeResultOutput

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

    public static class GetGatewayPluginConfluentConsume 
    {
        public static Task<GetGatewayPluginConfluentConsumeResult> InvokeAsync(GetGatewayPluginConfluentConsumeArgs args, InvokeOptions? opts = null)
        public static Output<GetGatewayPluginConfluentConsumeResult> Invoke(GetGatewayPluginConfluentConsumeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGatewayPluginConfluentConsumeResult> getGatewayPluginConfluentConsume(GetGatewayPluginConfluentConsumeArgs args, InvokeOptions options)
    public static Output<GetGatewayPluginConfluentConsumeResult> getGatewayPluginConfluentConsume(GetGatewayPluginConfluentConsumeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: konnect:index/getGatewayPluginConfluentConsume:getGatewayPluginConfluentConsume
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getGatewayPluginConfluentConsume Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginConfluentConsumeConfig

    AutoOffsetReset string
    The offset to start from when there is no initial offset in the consumer group.
    BootstrapServers List<GetGatewayPluginConfluentConsumeConfigBootstrapServer>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    ClusterApiKey string
    Username/Apikey for SASL authentication.
    ClusterApiSecret string
    Password/ApiSecret for SASL authentication.
    ClusterName string
    An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.
    CommitStrategy string
    The strategy to use for committing offsets.
    ConfluentCloudApiKey string
    Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.
    ConfluentCloudApiSecret string
    The corresponding secret for the Confluent Cloud API key.
    Keepalive double
    Keepalive timeout in milliseconds.
    KeepaliveEnabled bool
    MessageDeserializer string
    The deserializer to use for the consumed messages.
    Mode string
    The mode of operation for the plugin.
    Timeout double
    Socket timeout in milliseconds.
    Topics List<GetGatewayPluginConfluentConsumeConfigTopic>
    The Kafka topics and their configuration you want to consume from.
    AutoOffsetReset string
    The offset to start from when there is no initial offset in the consumer group.
    BootstrapServers []GetGatewayPluginConfluentConsumeConfigBootstrapServer
    Set of bootstrap brokers in a {host: host, port: port} list format.
    ClusterApiKey string
    Username/Apikey for SASL authentication.
    ClusterApiSecret string
    Password/ApiSecret for SASL authentication.
    ClusterName string
    An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.
    CommitStrategy string
    The strategy to use for committing offsets.
    ConfluentCloudApiKey string
    Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.
    ConfluentCloudApiSecret string
    The corresponding secret for the Confluent Cloud API key.
    Keepalive float64
    Keepalive timeout in milliseconds.
    KeepaliveEnabled bool
    MessageDeserializer string
    The deserializer to use for the consumed messages.
    Mode string
    The mode of operation for the plugin.
    Timeout float64
    Socket timeout in milliseconds.
    Topics []GetGatewayPluginConfluentConsumeConfigTopic
    The Kafka topics and their configuration you want to consume from.
    autoOffsetReset String
    The offset to start from when there is no initial offset in the consumer group.
    bootstrapServers List<GetGatewayPluginConfluentConsumeConfigBootstrapServer>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    clusterApiKey String
    Username/Apikey for SASL authentication.
    clusterApiSecret String
    Password/ApiSecret for SASL authentication.
    clusterName String
    An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.
    commitStrategy String
    The strategy to use for committing offsets.
    confluentCloudApiKey String
    Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.
    confluentCloudApiSecret String
    The corresponding secret for the Confluent Cloud API key.
    keepalive Double
    Keepalive timeout in milliseconds.
    keepaliveEnabled Boolean
    messageDeserializer String
    The deserializer to use for the consumed messages.
    mode String
    The mode of operation for the plugin.
    timeout Double
    Socket timeout in milliseconds.
    topics List<GetGatewayPluginConfluentConsumeConfigTopic>
    The Kafka topics and their configuration you want to consume from.
    autoOffsetReset string
    The offset to start from when there is no initial offset in the consumer group.
    bootstrapServers GetGatewayPluginConfluentConsumeConfigBootstrapServer[]
    Set of bootstrap brokers in a {host: host, port: port} list format.
    clusterApiKey string
    Username/Apikey for SASL authentication.
    clusterApiSecret string
    Password/ApiSecret for SASL authentication.
    clusterName string
    An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.
    commitStrategy string
    The strategy to use for committing offsets.
    confluentCloudApiKey string
    Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.
    confluentCloudApiSecret string
    The corresponding secret for the Confluent Cloud API key.
    keepalive number
    Keepalive timeout in milliseconds.
    keepaliveEnabled boolean
    messageDeserializer string
    The deserializer to use for the consumed messages.
    mode string
    The mode of operation for the plugin.
    timeout number
    Socket timeout in milliseconds.
    topics GetGatewayPluginConfluentConsumeConfigTopic[]
    The Kafka topics and their configuration you want to consume from.
    auto_offset_reset str
    The offset to start from when there is no initial offset in the consumer group.
    bootstrap_servers Sequence[GetGatewayPluginConfluentConsumeConfigBootstrapServer]
    Set of bootstrap brokers in a {host: host, port: port} list format.
    cluster_api_key str
    Username/Apikey for SASL authentication.
    cluster_api_secret str
    Password/ApiSecret for SASL authentication.
    cluster_name str
    An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.
    commit_strategy str
    The strategy to use for committing offsets.
    confluent_cloud_api_key str
    Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.
    confluent_cloud_api_secret str
    The corresponding secret for the Confluent Cloud API key.
    keepalive float
    Keepalive timeout in milliseconds.
    keepalive_enabled bool
    message_deserializer str
    The deserializer to use for the consumed messages.
    mode str
    The mode of operation for the plugin.
    timeout float
    Socket timeout in milliseconds.
    topics Sequence[GetGatewayPluginConfluentConsumeConfigTopic]
    The Kafka topics and their configuration you want to consume from.
    autoOffsetReset String
    The offset to start from when there is no initial offset in the consumer group.
    bootstrapServers List<Property Map>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    clusterApiKey String
    Username/Apikey for SASL authentication.
    clusterApiSecret String
    Password/ApiSecret for SASL authentication.
    clusterName String
    An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.
    commitStrategy String
    The strategy to use for committing offsets.
    confluentCloudApiKey String
    Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.
    confluentCloudApiSecret String
    The corresponding secret for the Confluent Cloud API key.
    keepalive Number
    Keepalive timeout in milliseconds.
    keepaliveEnabled Boolean
    messageDeserializer String
    The deserializer to use for the consumed messages.
    mode String
    The mode of operation for the plugin.
    timeout Number
    Socket timeout in milliseconds.
    topics List<Property Map>
    The Kafka topics and their configuration you want to consume from.

    GetGatewayPluginConfluentConsumeConfigBootstrapServer

    Host string
    A string representing a host name, such as example.com.
    Port double
    An integer representing a port number between 0 and 65535, inclusive.
    Host string
    A string representing a host name, such as example.com.
    Port float64
    An integer representing a port number between 0 and 65535, inclusive.
    host String
    A string representing a host name, such as example.com.
    port Double
    An integer representing a port number between 0 and 65535, inclusive.
    host string
    A string representing a host name, such as example.com.
    port number
    An integer representing a port number between 0 and 65535, inclusive.
    host str
    A string representing a host name, such as example.com.
    port float
    An integer representing a port number between 0 and 65535, inclusive.
    host String
    A string representing a host name, such as example.com.
    port Number
    An integer representing a port number between 0 and 65535, inclusive.

    GetGatewayPluginConfluentConsumeConfigTopic

    Name string
    Name string
    name String
    name string
    name str
    name String

    GetGatewayPluginConfluentConsumeConsumer

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginConfluentConsumeOrdering

    GetGatewayPluginConfluentConsumeOrderingAfter

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginConfluentConsumeOrderingBefore

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginConfluentConsumeRoute

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginConfluentConsumeService

    Id string
    Id string
    id String
    id string
    id str
    id String

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 2.7.3 published on Tuesday, May 13, 2025 by kong