1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginKafkaUpstream
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.getGatewayPluginKafkaUpstream

Explore with Pulumi AI

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>
Copy
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]
Copy
func LookupGatewayPluginKafkaUpstream(ctx *Context, args *LookupGatewayPluginKafkaUpstreamArgs, opts ...InvokeOption) (*LookupGatewayPluginKafkaUpstreamResult, error)
func LookupGatewayPluginKafkaUpstreamOutput(ctx *Context, args *LookupGatewayPluginKafkaUpstreamOutputArgs, opts ...InvokeOption) LookupGatewayPluginKafkaUpstreamResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetGatewayPluginKafkaUpstreamResult> getGatewayPluginKafkaUpstream(GetGatewayPluginKafkaUpstreamArgs args, InvokeOptions options)
public static Output<GetGatewayPluginKafkaUpstreamResult> getGatewayPluginKafkaUpstream(GetGatewayPluginKafkaUpstreamArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayPluginKafkaUpstream:getGatewayPluginKafkaUpstream
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ControlPlaneId This property is required. string
ControlPlaneId This property is required. string
controlPlaneId This property is required. String
controlPlaneId This property is required. string
control_plane_id This property is required. str
controlPlaneId This property is required. String

getGatewayPluginKafkaUpstream Result

The following output properties are available:

Supporting Types

GetGatewayPluginKafkaUpstreamConfig

Authentication This property is required. GetGatewayPluginKafkaUpstreamConfigAuthentication
BootstrapServers This property is required. List<GetGatewayPluginKafkaUpstreamConfigBootstrapServer>
Set of bootstrap brokers in a {host: host, port: port} list format.
ClusterName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. double
Keepalive timeout in milliseconds.
KeepaliveEnabled This property is required. bool
ProducerAsync This property is required. bool
Flag to enable asynchronous mode.
ProducerAsyncBufferingLimitsMessagesInMemory This property is required. double
Maximum number of messages that can be buffered in memory in asynchronous mode.
ProducerAsyncFlushTimeout This property is required. double
Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
ProducerRequestAcks This property is required. 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 This property is required. double
Maximum size of a Produce request in bytes.
ProducerRequestLimitsMessagesPerRequest This property is required. double
Maximum number of messages to include into a single producer request.
ProducerRequestRetriesBackoffTimeout This property is required. double
Backoff interval between retry attempts in milliseconds.
ProducerRequestRetriesMaxAttempts This property is required. double
Maximum number of retry attempts per single Produce request.
ProducerRequestTimeout This property is required. double
Time to wait for a Produce response in milliseconds.
Security This property is required. GetGatewayPluginKafkaUpstreamConfigSecurity
Timeout This property is required. double
Socket timeout in milliseconds.
Topic This property is required. string
The Kafka topic to publish to.
Authentication This property is required. GetGatewayPluginKafkaUpstreamConfigAuthentication
BootstrapServers This property is required. []GetGatewayPluginKafkaUpstreamConfigBootstrapServer
Set of bootstrap brokers in a {host: host, port: port} list format.
ClusterName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. float64
Keepalive timeout in milliseconds.
KeepaliveEnabled This property is required. bool
ProducerAsync This property is required. bool
Flag to enable asynchronous mode.
ProducerAsyncBufferingLimitsMessagesInMemory This property is required. float64
Maximum number of messages that can be buffered in memory in asynchronous mode.
ProducerAsyncFlushTimeout This property is required. float64
Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
ProducerRequestAcks This property is required. 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 This property is required. float64
Maximum size of a Produce request in bytes.
ProducerRequestLimitsMessagesPerRequest This property is required. float64
Maximum number of messages to include into a single producer request.
ProducerRequestRetriesBackoffTimeout This property is required. float64
Backoff interval between retry attempts in milliseconds.
ProducerRequestRetriesMaxAttempts This property is required. float64
Maximum number of retry attempts per single Produce request.
ProducerRequestTimeout This property is required. float64
Time to wait for a Produce response in milliseconds.
Security This property is required. GetGatewayPluginKafkaUpstreamConfigSecurity
Timeout This property is required. float64
Socket timeout in milliseconds.
Topic This property is required. string
The Kafka topic to publish to.
authentication This property is required. GetGatewayPluginKafkaUpstreamConfigAuthentication
bootstrapServers This property is required. List<GetGatewayPluginKafkaUpstreamConfigBootstrapServer>
Set of bootstrap brokers in a {host: host, port: port} list format.
clusterName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. Double
Keepalive timeout in milliseconds.
keepaliveEnabled This property is required. Boolean
producerAsync This property is required. Boolean
Flag to enable asynchronous mode.
producerAsyncBufferingLimitsMessagesInMemory This property is required. Double
Maximum number of messages that can be buffered in memory in asynchronous mode.
producerAsyncFlushTimeout This property is required. Double
Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
producerRequestAcks This property is required. 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 This property is required. Double
Maximum size of a Produce request in bytes.
producerRequestLimitsMessagesPerRequest This property is required. Double
Maximum number of messages to include into a single producer request.
producerRequestRetriesBackoffTimeout This property is required. Double
Backoff interval between retry attempts in milliseconds.
producerRequestRetriesMaxAttempts This property is required. Double
Maximum number of retry attempts per single Produce request.
producerRequestTimeout This property is required. Double
Time to wait for a Produce response in milliseconds.
security This property is required. GetGatewayPluginKafkaUpstreamConfigSecurity
timeout This property is required. Double
Socket timeout in milliseconds.
topic This property is required. String
The Kafka topic to publish to.
authentication This property is required. GetGatewayPluginKafkaUpstreamConfigAuthentication
bootstrapServers This property is required. GetGatewayPluginKafkaUpstreamConfigBootstrapServer[]
Set of bootstrap brokers in a {host: host, port: port} list format.
clusterName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. number
Keepalive timeout in milliseconds.
keepaliveEnabled This property is required. boolean
producerAsync This property is required. boolean
Flag to enable asynchronous mode.
producerAsyncBufferingLimitsMessagesInMemory This property is required. number
Maximum number of messages that can be buffered in memory in asynchronous mode.
producerAsyncFlushTimeout This property is required. number
Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
producerRequestAcks This property is required. 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 This property is required. number
Maximum size of a Produce request in bytes.
producerRequestLimitsMessagesPerRequest This property is required. number
Maximum number of messages to include into a single producer request.
producerRequestRetriesBackoffTimeout This property is required. number
Backoff interval between retry attempts in milliseconds.
producerRequestRetriesMaxAttempts This property is required. number
Maximum number of retry attempts per single Produce request.
producerRequestTimeout This property is required. number
Time to wait for a Produce response in milliseconds.
security This property is required. GetGatewayPluginKafkaUpstreamConfigSecurity
timeout This property is required. number
Socket timeout in milliseconds.
topic This property is required. string
The Kafka topic to publish to.
authentication This property is required. GetGatewayPluginKafkaUpstreamConfigAuthentication
bootstrap_servers This property is required. Sequence[GetGatewayPluginKafkaUpstreamConfigBootstrapServer]
Set of bootstrap brokers in a {host: host, port: port} list format.
cluster_name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. float
Keepalive timeout in milliseconds.
keepalive_enabled This property is required. bool
producer_async This property is required. bool
Flag to enable asynchronous mode.
producer_async_buffering_limits_messages_in_memory This property is required. float
Maximum number of messages that can be buffered in memory in asynchronous mode.
producer_async_flush_timeout This property is required. float
Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
producer_request_acks This property is required. 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 This property is required. float
Maximum size of a Produce request in bytes.
producer_request_limits_messages_per_request This property is required. float
Maximum number of messages to include into a single producer request.
producer_request_retries_backoff_timeout This property is required. float
Backoff interval between retry attempts in milliseconds.
producer_request_retries_max_attempts This property is required. float
Maximum number of retry attempts per single Produce request.
producer_request_timeout This property is required. float
Time to wait for a Produce response in milliseconds.
security This property is required. GetGatewayPluginKafkaUpstreamConfigSecurity
timeout This property is required. float
Socket timeout in milliseconds.
topic This property is required. str
The Kafka topic to publish to.
authentication This property is required. Property Map
bootstrapServers This property is required. List<Property Map>
Set of bootstrap brokers in a {host: host, port: port} list format.
clusterName This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. Number
Keepalive timeout in milliseconds.
keepaliveEnabled This property is required. Boolean
producerAsync This property is required. Boolean
Flag to enable asynchronous mode.
producerAsyncBufferingLimitsMessagesInMemory This property is required. Number
Maximum number of messages that can be buffered in memory in asynchronous mode.
producerAsyncFlushTimeout This property is required. Number
Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
producerRequestAcks This property is required. 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 This property is required. Number
Maximum size of a Produce request in bytes.
producerRequestLimitsMessagesPerRequest This property is required. Number
Maximum number of messages to include into a single producer request.
producerRequestRetriesBackoffTimeout This property is required. Number
Backoff interval between retry attempts in milliseconds.
producerRequestRetriesMaxAttempts This property is required. Number
Maximum number of retry attempts per single Produce request.
producerRequestTimeout This property is required. Number
Time to wait for a Produce response in milliseconds.
security This property is required. Property Map
timeout This property is required. Number
Socket timeout in milliseconds.
topic This property is required. String
The Kafka topic to publish to.

GetGatewayPluginKafkaUpstreamConfigAuthentication

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

GetGatewayPluginKafkaUpstreamConfigBootstrapServer

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

GetGatewayPluginKafkaUpstreamConfigSecurity

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

GetGatewayPluginKafkaUpstreamConsumer

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginKafkaUpstreamOrdering

after This property is required. Property Map
before This property is required. Property Map

GetGatewayPluginKafkaUpstreamOrderingAfter

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginKafkaUpstreamOrderingBefore

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginKafkaUpstreamRoute

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginKafkaUpstreamService

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.