Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginKafkaUpstream
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.getGatewayPluginKafkaUpstream

Explore with Pulumi AI

konnect logo
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

    Using getGatewayPluginKafkaUpstream

    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 getGatewayPluginKafkaUpstream(args: GetGatewayPluginKafkaUpstreamArgs, opts?: InvokeOptions): Promise<GetGatewayPluginKafkaUpstreamResult>
function getGatewayPluginKafkaUpstreamOutput(args: GetGatewayPluginKafkaUpstreamOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginKafkaUpstreamResult>
    def get_gateway_plugin_kafka_upstream(control_plane_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetGatewayPluginKafkaUpstreamResult
def get_gateway_plugin_kafka_upstream_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginKafkaUpstreamResult]
    func LookupGatewayPluginKafkaUpstream(ctx *Context, args *LookupGatewayPluginKafkaUpstreamArgs, opts ...InvokeOption) (*LookupGatewayPluginKafkaUpstreamResult, error)
func LookupGatewayPluginKafkaUpstreamOutput(ctx *Context, args *LookupGatewayPluginKafkaUpstreamOutputArgs, opts ...InvokeOption) LookupGatewayPluginKafkaUpstreamResultOutput

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

    public static class GetGatewayPluginKafkaUpstream 
{
    public static Task<GetGatewayPluginKafkaUpstreamResult> InvokeAsync(GetGatewayPluginKafkaUpstreamArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginKafkaUpstreamResult> Invoke(GetGatewayPluginKafkaUpstreamInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayPluginKafkaUpstreamResult> getGatewayPluginKafkaUpstream(GetGatewayPluginKafkaUpstreamArgs args, InvokeOptions options)
public static Output<GetGatewayPluginKafkaUpstreamResult> getGatewayPluginKafkaUpstream(GetGatewayPluginKafkaUpstreamArgs args, InvokeOptions options)

    fn::invoke:
  function: konnect:index/getGatewayPluginKafkaUpstream:getGatewayPluginKafkaUpstream
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getGatewayPluginKafkaUpstream Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginKafkaUpstreamConfig

    Authentication GetGatewayPluginKafkaUpstreamConfigAuthentication
    BootstrapServers List<GetGatewayPluginKafkaUpstreamConfigBootstrapServer>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    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.
    ForwardBody bool
    Include the request body in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    ForwardHeaders bool
    Include the request headers in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    ForwardMethod bool
    Include the request method in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    ForwardUri bool
    Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    Keepalive double
    Keepalive timeout in milliseconds.
    KeepaliveEnabled bool
    ProducerAsync bool
    Flag to enable asynchronous mode.
    ProducerAsyncBufferingLimitsMessagesInMemory double
    Maximum number of messages that can be buffered in memory in asynchronous mode.
    ProducerAsyncFlushTimeout double
    Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
    ProducerRequestAcks double
    The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).
    ProducerRequestLimitsBytesPerRequest double
    Maximum size of a Produce request in bytes.
    ProducerRequestLimitsMessagesPerRequest double
    Maximum number of messages to include into a single producer request.
    ProducerRequestRetriesBackoffTimeout double
    Backoff interval between retry attempts in milliseconds.
    ProducerRequestRetriesMaxAttempts double
    Maximum number of retry attempts per single Produce request.
    ProducerRequestTimeout double
    Time to wait for a Produce response in milliseconds.
    Security GetGatewayPluginKafkaUpstreamConfigSecurity
    Timeout double
    Socket timeout in milliseconds.
    Topic string
    The Kafka topic to publish to.
    Authentication GetGatewayPluginKafkaUpstreamConfigAuthentication
    BootstrapServers []GetGatewayPluginKafkaUpstreamConfigBootstrapServer
    Set of bootstrap brokers in a {host: host, port: port} list format.
    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.
    ForwardBody bool
    Include the request body in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    ForwardHeaders bool
    Include the request headers in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    ForwardMethod bool
    Include the request method in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    ForwardUri bool
    Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    Keepalive float64
    Keepalive timeout in milliseconds.
    KeepaliveEnabled bool
    ProducerAsync bool
    Flag to enable asynchronous mode.
    ProducerAsyncBufferingLimitsMessagesInMemory float64
    Maximum number of messages that can be buffered in memory in asynchronous mode.
    ProducerAsyncFlushTimeout float64
    Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
    ProducerRequestAcks float64
    The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).
    ProducerRequestLimitsBytesPerRequest float64
    Maximum size of a Produce request in bytes.
    ProducerRequestLimitsMessagesPerRequest float64
    Maximum number of messages to include into a single producer request.
    ProducerRequestRetriesBackoffTimeout float64
    Backoff interval between retry attempts in milliseconds.
    ProducerRequestRetriesMaxAttempts float64
    Maximum number of retry attempts per single Produce request.
    ProducerRequestTimeout float64
    Time to wait for a Produce response in milliseconds.
    Security GetGatewayPluginKafkaUpstreamConfigSecurity
    Timeout float64
    Socket timeout in milliseconds.
    Topic string
    The Kafka topic to publish to.
    authentication GetGatewayPluginKafkaUpstreamConfigAuthentication
    bootstrapServers List<GetGatewayPluginKafkaUpstreamConfigBootstrapServer>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    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.
    forwardBody Boolean
    Include the request body in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forwardHeaders Boolean
    Include the request headers in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forwardMethod Boolean
    Include the request method in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forwardUri Boolean
    Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    keepalive Double
    Keepalive timeout in milliseconds.
    keepaliveEnabled Boolean
    producerAsync Boolean
    Flag to enable asynchronous mode.
    producerAsyncBufferingLimitsMessagesInMemory Double
    Maximum number of messages that can be buffered in memory in asynchronous mode.
    producerAsyncFlushTimeout Double
    Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
    producerRequestAcks Double
    The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).
    producerRequestLimitsBytesPerRequest Double
    Maximum size of a Produce request in bytes.
    producerRequestLimitsMessagesPerRequest Double
    Maximum number of messages to include into a single producer request.
    producerRequestRetriesBackoffTimeout Double
    Backoff interval between retry attempts in milliseconds.
    producerRequestRetriesMaxAttempts Double
    Maximum number of retry attempts per single Produce request.
    producerRequestTimeout Double
    Time to wait for a Produce response in milliseconds.
    security GetGatewayPluginKafkaUpstreamConfigSecurity
    timeout Double
    Socket timeout in milliseconds.
    topic String
    The Kafka topic to publish to.
    authentication GetGatewayPluginKafkaUpstreamConfigAuthentication
    bootstrapServers GetGatewayPluginKafkaUpstreamConfigBootstrapServer[]
    Set of bootstrap brokers in a {host: host, port: port} list format.
    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.
    forwardBody boolean
    Include the request body in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forwardHeaders boolean
    Include the request headers in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forwardMethod boolean
    Include the request method in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forwardUri boolean
    Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    keepalive number
    Keepalive timeout in milliseconds.
    keepaliveEnabled boolean
    producerAsync boolean
    Flag to enable asynchronous mode.
    producerAsyncBufferingLimitsMessagesInMemory number
    Maximum number of messages that can be buffered in memory in asynchronous mode.
    producerAsyncFlushTimeout number
    Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
    producerRequestAcks number
    The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).
    producerRequestLimitsBytesPerRequest number
    Maximum size of a Produce request in bytes.
    producerRequestLimitsMessagesPerRequest number
    Maximum number of messages to include into a single producer request.
    producerRequestRetriesBackoffTimeout number
    Backoff interval between retry attempts in milliseconds.
    producerRequestRetriesMaxAttempts number
    Maximum number of retry attempts per single Produce request.
    producerRequestTimeout number
    Time to wait for a Produce response in milliseconds.
    security GetGatewayPluginKafkaUpstreamConfigSecurity
    timeout number
    Socket timeout in milliseconds.
    topic string
    The Kafka topic to publish to.
    authentication GetGatewayPluginKafkaUpstreamConfigAuthentication
    bootstrap_servers Sequence[GetGatewayPluginKafkaUpstreamConfigBootstrapServer]
    Set of bootstrap brokers in a {host: host, port: port} list format.
    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.
    forward_body bool
    Include the request body in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forward_headers bool
    Include the request headers in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forward_method bool
    Include the request method in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forward_uri bool
    Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    keepalive float
    Keepalive timeout in milliseconds.
    keepalive_enabled bool
    producer_async bool
    Flag to enable asynchronous mode.
    producer_async_buffering_limits_messages_in_memory float
    Maximum number of messages that can be buffered in memory in asynchronous mode.
    producer_async_flush_timeout float
    Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
    producer_request_acks float
    The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).
    producer_request_limits_bytes_per_request float
    Maximum size of a Produce request in bytes.
    producer_request_limits_messages_per_request float
    Maximum number of messages to include into a single producer request.
    producer_request_retries_backoff_timeout float
    Backoff interval between retry attempts in milliseconds.
    producer_request_retries_max_attempts float
    Maximum number of retry attempts per single Produce request.
    producer_request_timeout float
    Time to wait for a Produce response in milliseconds.
    security GetGatewayPluginKafkaUpstreamConfigSecurity
    timeout float
    Socket timeout in milliseconds.
    topic str
    The Kafka topic to publish to.
    authentication Property Map
    bootstrapServers List<Property Map>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    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.
    forwardBody Boolean
    Include the request body in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forwardHeaders Boolean
    Include the request headers in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forwardMethod Boolean
    Include the request method in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    forwardUri Boolean
    Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.
    keepalive Number
    Keepalive timeout in milliseconds.
    keepaliveEnabled Boolean
    producerAsync Boolean
    Flag to enable asynchronous mode.
    producerAsyncBufferingLimitsMessagesInMemory Number
    Maximum number of messages that can be buffered in memory in asynchronous mode.
    producerAsyncFlushTimeout Number
    Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
    producerRequestAcks Number
    The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).
    producerRequestLimitsBytesPerRequest Number
    Maximum size of a Produce request in bytes.
    producerRequestLimitsMessagesPerRequest Number
    Maximum number of messages to include into a single producer request.
    producerRequestRetriesBackoffTimeout Number
    Backoff interval between retry attempts in milliseconds.
    producerRequestRetriesMaxAttempts Number
    Maximum number of retry attempts per single Produce request.
    producerRequestTimeout Number
    Time to wait for a Produce response in milliseconds.
    security Property Map
    timeout Number
    Socket timeout in milliseconds.
    topic String
    The Kafka topic to publish to.

    GetGatewayPluginKafkaUpstreamConfigAuthentication

    Mechanism string
    The SASL authentication mechanism. Supported options: PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512.
    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, SCRAM-SHA-256, or SCRAM-SHA-512.
    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, SCRAM-SHA-256, or SCRAM-SHA-512.
    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, SCRAM-SHA-256, or SCRAM-SHA-512.
    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, SCRAM-SHA-256, or SCRAM-SHA-512.
    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, SCRAM-SHA-256, or SCRAM-SHA-512.
    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.

    GetGatewayPluginKafkaUpstreamConfigBootstrapServer

    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.

    GetGatewayPluginKafkaUpstreamConfigSecurity

    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.

    GetGatewayPluginKafkaUpstreamConsumer

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

    GetGatewayPluginKafkaUpstreamOrdering

    GetGatewayPluginKafkaUpstreamOrderingAfter

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

    GetGatewayPluginKafkaUpstreamOrderingBefore

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

    GetGatewayPluginKafkaUpstreamRoute

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

    GetGatewayPluginKafkaUpstreamService

    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.4.1 published on Thursday, Mar 13, 2025 by kong
    kong/terraform-provider-konnect