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

konnect.getGatewayPluginKafkaConsume

Explore with Pulumi AI

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

    Using getGatewayPluginKafkaConsume

    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 getGatewayPluginKafkaConsume(args: GetGatewayPluginKafkaConsumeArgs, opts?: InvokeOptions): Promise<GetGatewayPluginKafkaConsumeResult>
    function getGatewayPluginKafkaConsumeOutput(args: GetGatewayPluginKafkaConsumeOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginKafkaConsumeResult>
    def get_gateway_plugin_kafka_consume(control_plane_id: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetGatewayPluginKafkaConsumeResult
    def get_gateway_plugin_kafka_consume_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginKafkaConsumeResult]
    func LookupGatewayPluginKafkaConsume(ctx *Context, args *LookupGatewayPluginKafkaConsumeArgs, opts ...InvokeOption) (*LookupGatewayPluginKafkaConsumeResult, error)
    func LookupGatewayPluginKafkaConsumeOutput(ctx *Context, args *LookupGatewayPluginKafkaConsumeOutputArgs, opts ...InvokeOption) LookupGatewayPluginKafkaConsumeResultOutput

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

    public static class GetGatewayPluginKafkaConsume 
    {
        public static Task<GetGatewayPluginKafkaConsumeResult> InvokeAsync(GetGatewayPluginKafkaConsumeArgs args, InvokeOptions? opts = null)
        public static Output<GetGatewayPluginKafkaConsumeResult> Invoke(GetGatewayPluginKafkaConsumeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGatewayPluginKafkaConsumeResult> getGatewayPluginKafkaConsume(GetGatewayPluginKafkaConsumeArgs args, InvokeOptions options)
    public static Output<GetGatewayPluginKafkaConsumeResult> getGatewayPluginKafkaConsume(GetGatewayPluginKafkaConsumeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: konnect:index/getGatewayPluginKafkaConsume:getGatewayPluginKafkaConsume
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getGatewayPluginKafkaConsume Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginKafkaConsumeConfig

    Authentication GetGatewayPluginKafkaConsumeConfigAuthentication
    AutoOffsetReset string
    The offset to start from when there is no initial offset in the consumer group.
    BootstrapServers List<GetGatewayPluginKafkaConsumeConfigBootstrapServer>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    ClusterName string
    An identifier for the Kafka cluster.
    CommitStrategy string
    The strategy to use for committing offsets.
    MessageDeserializer string
    The deserializer to use for the consumed messages.
    Mode string
    The mode of operation for the plugin.
    Security GetGatewayPluginKafkaConsumeConfigSecurity
    Topics List<GetGatewayPluginKafkaConsumeConfigTopic>
    The Kafka topics and their configuration you want to consume from.
    Authentication GetGatewayPluginKafkaConsumeConfigAuthentication
    AutoOffsetReset string
    The offset to start from when there is no initial offset in the consumer group.
    BootstrapServers []GetGatewayPluginKafkaConsumeConfigBootstrapServer
    Set of bootstrap brokers in a {host: host, port: port} list format.
    ClusterName string
    An identifier for the Kafka cluster.
    CommitStrategy string
    The strategy to use for committing offsets.
    MessageDeserializer string
    The deserializer to use for the consumed messages.
    Mode string
    The mode of operation for the plugin.
    Security GetGatewayPluginKafkaConsumeConfigSecurity
    Topics []GetGatewayPluginKafkaConsumeConfigTopic
    The Kafka topics and their configuration you want to consume from.
    authentication GetGatewayPluginKafkaConsumeConfigAuthentication
    autoOffsetReset String
    The offset to start from when there is no initial offset in the consumer group.
    bootstrapServers List<GetGatewayPluginKafkaConsumeConfigBootstrapServer>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    clusterName String
    An identifier for the Kafka cluster.
    commitStrategy String
    The strategy to use for committing offsets.
    messageDeserializer String
    The deserializer to use for the consumed messages.
    mode String
    The mode of operation for the plugin.
    security GetGatewayPluginKafkaConsumeConfigSecurity
    topics List<GetGatewayPluginKafkaConsumeConfigTopic>
    The Kafka topics and their configuration you want to consume from.
    authentication GetGatewayPluginKafkaConsumeConfigAuthentication
    autoOffsetReset string
    The offset to start from when there is no initial offset in the consumer group.
    bootstrapServers GetGatewayPluginKafkaConsumeConfigBootstrapServer[]
    Set of bootstrap brokers in a {host: host, port: port} list format.
    clusterName string
    An identifier for the Kafka cluster.
    commitStrategy string
    The strategy to use for committing offsets.
    messageDeserializer string
    The deserializer to use for the consumed messages.
    mode string
    The mode of operation for the plugin.
    security GetGatewayPluginKafkaConsumeConfigSecurity
    topics GetGatewayPluginKafkaConsumeConfigTopic[]
    The Kafka topics and their configuration you want to consume from.
    authentication GetGatewayPluginKafkaConsumeConfigAuthentication
    auto_offset_reset str
    The offset to start from when there is no initial offset in the consumer group.
    bootstrap_servers Sequence[GetGatewayPluginKafkaConsumeConfigBootstrapServer]
    Set of bootstrap brokers in a {host: host, port: port} list format.
    cluster_name str
    An identifier for the Kafka cluster.
    commit_strategy str
    The strategy to use for committing offsets.
    message_deserializer str
    The deserializer to use for the consumed messages.
    mode str
    The mode of operation for the plugin.
    security GetGatewayPluginKafkaConsumeConfigSecurity
    topics Sequence[GetGatewayPluginKafkaConsumeConfigTopic]
    The Kafka topics and their configuration you want to consume from.
    authentication Property Map
    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.
    clusterName String
    An identifier for the Kafka cluster.
    commitStrategy String
    The strategy to use for committing offsets.
    messageDeserializer String
    The deserializer to use for the consumed messages.
    mode String
    The mode of operation for the plugin.
    security Property Map
    topics List<Property Map>
    The Kafka topics and their configuration you want to consume from.

    GetGatewayPluginKafkaConsumeConfigAuthentication

    Mechanism string
    The SASL authentication mechanism. Supported options: PLAIN or SCRAM-SHA-256.
    Password string
    Password for SASL authentication.
    Strategy string
    The authentication strategy for the plugin, the only option for the value is sasl.
    Tokenauth bool
    Enable this to indicate DelegationToken authentication
    User string
    Username for SASL authentication.
    Mechanism string
    The SASL authentication mechanism. Supported options: PLAIN or SCRAM-SHA-256.
    Password string
    Password for SASL authentication.
    Strategy string
    The authentication strategy for the plugin, the only option for the value is sasl.
    Tokenauth bool
    Enable this to indicate DelegationToken authentication
    User string
    Username for SASL authentication.
    mechanism String
    The SASL authentication mechanism. Supported options: PLAIN or SCRAM-SHA-256.
    password String
    Password for SASL authentication.
    strategy String
    The authentication strategy for the plugin, the only option for the value is sasl.
    tokenauth Boolean
    Enable this to indicate DelegationToken authentication
    user String
    Username for SASL authentication.
    mechanism string
    The SASL authentication mechanism. Supported options: PLAIN or SCRAM-SHA-256.
    password string
    Password for SASL authentication.
    strategy string
    The authentication strategy for the plugin, the only option for the value is sasl.
    tokenauth boolean
    Enable this to indicate DelegationToken authentication
    user string
    Username for SASL authentication.
    mechanism str
    The SASL authentication mechanism. Supported options: PLAIN or SCRAM-SHA-256.
    password str
    Password for SASL authentication.
    strategy str
    The authentication strategy for the plugin, the only option for the value is sasl.
    tokenauth bool
    Enable this to indicate DelegationToken authentication
    user str
    Username for SASL authentication.
    mechanism String
    The SASL authentication mechanism. Supported options: PLAIN or SCRAM-SHA-256.
    password String
    Password for SASL authentication.
    strategy String
    The authentication strategy for the plugin, the only option for the value is sasl.
    tokenauth Boolean
    Enable this to indicate DelegationToken authentication
    user String
    Username for SASL authentication.

    GetGatewayPluginKafkaConsumeConfigBootstrapServer

    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.

    GetGatewayPluginKafkaConsumeConfigSecurity

    CertificateId string
    UUID of certificate entity for mTLS authentication.
    Ssl bool
    Enables TLS.
    CertificateId string
    UUID of certificate entity for mTLS authentication.
    Ssl bool
    Enables TLS.
    certificateId String
    UUID of certificate entity for mTLS authentication.
    ssl Boolean
    Enables TLS.
    certificateId string
    UUID of certificate entity for mTLS authentication.
    ssl boolean
    Enables TLS.
    certificate_id str
    UUID of certificate entity for mTLS authentication.
    ssl bool
    Enables TLS.
    certificateId String
    UUID of certificate entity for mTLS authentication.
    ssl Boolean
    Enables TLS.

    GetGatewayPluginKafkaConsumeConfigTopic

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

    GetGatewayPluginKafkaConsumeConsumer

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

    GetGatewayPluginKafkaConsumeOrdering

    GetGatewayPluginKafkaConsumeOrderingAfter

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

    GetGatewayPluginKafkaConsumeOrderingBefore

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

    GetGatewayPluginKafkaConsumeRoute

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

    GetGatewayPluginKafkaConsumeService

    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