konnect 2.5.0, Apr 15 25

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

konnect.getGatewayPluginConfluent

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

Using getGatewayPluginConfluent

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.

TypeScript
Python
Go
C#
Java
YAML

function getGatewayPluginConfluent(args: GetGatewayPluginConfluentArgs, opts?: InvokeOptions): Promise<GetGatewayPluginConfluentResult>
function getGatewayPluginConfluentOutput(args: GetGatewayPluginConfluentOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginConfluentResult>

def get_gateway_plugin_confluent(control_plane_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetGatewayPluginConfluentResult
def get_gateway_plugin_confluent_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginConfluentResult]

func LookupGatewayPluginConfluent(ctx *Context, args *LookupGatewayPluginConfluentArgs, opts ...InvokeOption) (*LookupGatewayPluginConfluentResult, error)
func LookupGatewayPluginConfluentOutput(ctx *Context, args *LookupGatewayPluginConfluentOutputArgs, opts ...InvokeOption) LookupGatewayPluginConfluentResultOutput

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

public static class GetGatewayPluginConfluent 
{
    public static Task<GetGatewayPluginConfluentResult> InvokeAsync(GetGatewayPluginConfluentArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginConfluentResult> Invoke(GetGatewayPluginConfluentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayPluginConfluentResult> getGatewayPluginConfluent(GetGatewayPluginConfluentArgs args, InvokeOptions options)
public static Output<GetGatewayPluginConfluentResult> getGatewayPluginConfluent(GetGatewayPluginConfluentArgs args, InvokeOptions options)

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

The following arguments are supported:

ControlPlaneId string

ControlPlaneId string

controlPlaneId String

controlPlaneId string

control_plane_id str

controlPlaneId String

getGatewayPluginConfluent Result

The following output properties are available:

Config GetGatewayPluginConfluentConfig
Consumer GetGatewayPluginConfluentConsumer
ControlPlaneId string
CreatedAt double
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginConfluentOrdering
Protocols List<string>
Route GetGatewayPluginConfluentRoute
Service GetGatewayPluginConfluentService
Tags List<string>
UpdatedAt double

Config GetGatewayPluginConfluentConfig
Consumer GetGatewayPluginConfluentConsumer
ControlPlaneId string
CreatedAt float64
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginConfluentOrdering
Protocols []string
Route GetGatewayPluginConfluentRoute
Service GetGatewayPluginConfluentService
Tags []string
UpdatedAt float64

config GetGatewayPluginConfluentConfig
consumer GetGatewayPluginConfluentConsumer
controlPlaneId String
createdAt Double
enabled Boolean
id String
instanceName String
ordering GetGatewayPluginConfluentOrdering
protocols List<String>
route GetGatewayPluginConfluentRoute
service GetGatewayPluginConfluentService
tags List<String>
updatedAt Double

config GetGatewayPluginConfluentConfig
consumer GetGatewayPluginConfluentConsumer
controlPlaneId string
createdAt number
enabled boolean
id string
instanceName string
ordering GetGatewayPluginConfluentOrdering
protocols string[]
route GetGatewayPluginConfluentRoute
service GetGatewayPluginConfluentService
tags string[]
updatedAt number

config GetGatewayPluginConfluentConfig
consumer GetGatewayPluginConfluentConsumer
control_plane_id str
created_at float
enabled bool
id str
instance_name str
ordering GetGatewayPluginConfluentOrdering
protocols Sequence[str]
route GetGatewayPluginConfluentRoute
service GetGatewayPluginConfluentService
tags Sequence[str]
updated_at float

config Property Map
consumer Property Map
controlPlaneId String
createdAt Number
enabled Boolean
id String
instanceName String
ordering Property Map
protocols List<String>
route Property Map
service Property Map
tags List<String>
updatedAt Number

Supporting Types

GetGatewayPluginConfluentConfig

BootstrapServers List<GetGatewayPluginConfluentConfigBootstrapServer>: 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.
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.
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.
Timeout double: Socket timeout in milliseconds.
Topic string: The Kafka topic to publish to.

BootstrapServers []GetGatewayPluginConfluentConfigBootstrapServer: 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.
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.
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.
Timeout float64: Socket timeout in milliseconds.
Topic string: The Kafka topic to publish to.

bootstrapServers List<GetGatewayPluginConfluentConfigBootstrapServer>: 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.
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.
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.
timeout Double: Socket timeout in milliseconds.
topic String: The Kafka topic to publish to.

bootstrapServers GetGatewayPluginConfluentConfigBootstrapServer[]: 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.
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.
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.
timeout number: Socket timeout in milliseconds.
topic string: The Kafka topic to publish to.

bootstrap_servers Sequence[GetGatewayPluginConfluentConfigBootstrapServer]: 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.
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.
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.
timeout float: Socket timeout in milliseconds.
topic str: The Kafka topic to publish to.

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.
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.
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.
timeout Number: Socket timeout in milliseconds.
topic String: The Kafka topic to publish to.

GetGatewayPluginConfluentConfigBootstrapServer

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.

GetGatewayPluginConfluentConsumer

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginConfluentOrdering

After GetGatewayPluginConfluentOrderingAfter
Before GetGatewayPluginConfluentOrderingBefore

After GetGatewayPluginConfluentOrderingAfter
Before GetGatewayPluginConfluentOrderingBefore

after GetGatewayPluginConfluentOrderingAfter
before GetGatewayPluginConfluentOrderingBefore

after GetGatewayPluginConfluentOrderingAfter
before GetGatewayPluginConfluentOrderingBefore

after GetGatewayPluginConfluentOrderingAfter
before GetGatewayPluginConfluentOrderingBefore

after Property Map
before Property Map

GetGatewayPluginConfluentOrderingAfter

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginConfluentOrderingBefore

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginConfluentRoute

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginConfluentService

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 2.5.0 published on Tuesday, Apr 15, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayPluginConfluent

On this page

On this page

Using getGatewayPluginConfluent

getGatewayPluginConfluent Result

Supporting Types

GetGatewayPluginConfluentConfig

GetGatewayPluginConfluentConfigBootstrapServer

GetGatewayPluginConfluentConsumer

GetGatewayPluginConfluentOrdering

GetGatewayPluginConfluentOrderingAfter

GetGatewayPluginConfluentOrderingBefore

GetGatewayPluginConfluentRoute

GetGatewayPluginConfluentService

Package Details

On this page

On this page