konnect 2.5.0, Apr 15 25

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

konnect.GatewayPluginKafkaUpstream

Explore with Pulumi AI

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

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginKafkaUpstream;
import com.pulumi.konnect.GatewayPluginKafkaUpstreamArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaUpstreamConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaUpstreamConfigAuthenticationArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaUpstreamConfigSecurityArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaUpstreamConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaUpstreamOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaUpstreamOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaUpstreamOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaUpstreamRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginKafkaUpstreamServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myGatewaypluginkafkaupstream = new GatewayPluginKafkaUpstream("myGatewaypluginkafkaupstream", GatewayPluginKafkaUpstreamArgs.builder()
            .config(GatewayPluginKafkaUpstreamConfigArgs.builder()
                .authentication(GatewayPluginKafkaUpstreamConfigAuthenticationArgs.builder()
                    .mechanism("SCRAM-SHA-512")
                    .password("...my_password...")
                    .strategy("sasl")
                    .tokenauth(false)
                    .user("...my_user...")
                    .build())
                .bootstrap_servers(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .cluster_name("...my_cluster_name...")
                .forward_body(false)
                .forward_headers(true)
                .forward_method(true)
                .forward_uri(false)
                .keepalive(3)
                .keepalive_enabled(true)
                .producer_async(true)
                .producer_async_buffering_limits_messages_in_memory(5)
                .producer_async_flush_timeout(5)
                .producer_request_acks(1)
                .producer_request_limits_bytes_per_request(1)
                .producer_request_limits_messages_per_request(9)
                .producer_request_retries_backoff_timeout(4)
                .producer_request_retries_max_attempts(5)
                .producer_request_timeout(10)
                .security(GatewayPluginKafkaUpstreamConfigSecurityArgs.builder()
                    .certificateId("...my_certificate_id...")
                    .ssl(false)
                    .build())
                .timeout(0)
                .topic("...my_topic...")
                .build())
            .consumer(GatewayPluginKafkaUpstreamConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(10)
            .enabled(false)
            .gatewayPluginKafkaUpstreamId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginKafkaUpstreamOrderingArgs.builder()
                .after(GatewayPluginKafkaUpstreamOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginKafkaUpstreamOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("grpc")
            .route(GatewayPluginKafkaUpstreamRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginKafkaUpstreamServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .updatedAt(0)
            .build());

    }
}

resources:
  myGatewaypluginkafkaupstream:
    type: konnect:GatewayPluginKafkaUpstream
    properties:
      config:
        authentication:
          mechanism: SCRAM-SHA-512
          password: '...my_password...'
          strategy: sasl
          tokenauth: false
          user: '...my_user...'
        bootstrap_servers:
          - host: '...my_host...'
            port: 3969
        cluster_name: '...my_cluster_name...'
        forward_body: false
        forward_headers: true
        forward_method: true
        forward_uri: false
        keepalive: 3
        keepalive_enabled: true
        producer_async: true
        producer_async_buffering_limits_messages_in_memory: 5
        producer_async_flush_timeout: 5
        producer_request_acks: 1
        producer_request_limits_bytes_per_request: 1
        producer_request_limits_messages_per_request: 9
        producer_request_retries_backoff_timeout: 4
        producer_request_retries_max_attempts: 5
        producer_request_timeout: 10
        security:
          certificateId: '...my_certificate_id...'
          ssl: false
        timeout: 0
        topic: '...my_topic...'
      consumer:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 10
      enabled: false
      gatewayPluginKafkaUpstreamId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - grpc
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
      updatedAt: 0

Create GatewayPluginKafkaUpstream Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GatewayPluginKafkaUpstream(name: string, args: GatewayPluginKafkaUpstreamArgs, opts?: CustomResourceOptions);

@overload
def GatewayPluginKafkaUpstream(resource_name: str,
                               args: GatewayPluginKafkaUpstreamArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def GatewayPluginKafkaUpstream(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               control_plane_id: Optional[str] = None,
                               instance_name: Optional[str] = None,
                               consumer: Optional[GatewayPluginKafkaUpstreamConsumerArgs] = None,
                               created_at: Optional[float] = None,
                               enabled: Optional[bool] = None,
                               gateway_plugin_kafka_upstream_id: Optional[str] = None,
                               config: Optional[GatewayPluginKafkaUpstreamConfigArgs] = None,
                               ordering: Optional[GatewayPluginKafkaUpstreamOrderingArgs] = None,
                               protocols: Optional[Sequence[str]] = None,
                               route: Optional[GatewayPluginKafkaUpstreamRouteArgs] = None,
                               service: Optional[GatewayPluginKafkaUpstreamServiceArgs] = None,
                               tags: Optional[Sequence[str]] = None,
                               updated_at: Optional[float] = None)

func NewGatewayPluginKafkaUpstream(ctx *Context, name string, args GatewayPluginKafkaUpstreamArgs, opts ...ResourceOption) (*GatewayPluginKafkaUpstream, error)

public GatewayPluginKafkaUpstream(string name, GatewayPluginKafkaUpstreamArgs args, CustomResourceOptions? opts = null)

public GatewayPluginKafkaUpstream(String name, GatewayPluginKafkaUpstreamArgs args)
public GatewayPluginKafkaUpstream(String name, GatewayPluginKafkaUpstreamArgs args, CustomResourceOptions options)

type: konnect:GatewayPluginKafkaUpstream
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args GatewayPluginKafkaUpstreamArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args GatewayPluginKafkaUpstreamArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GatewayPluginKafkaUpstreamArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GatewayPluginKafkaUpstreamArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GatewayPluginKafkaUpstreamArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var gatewayPluginKafkaUpstreamResource = new Konnect.GatewayPluginKafkaUpstream("gatewayPluginKafkaUpstreamResource", new()
{
    ControlPlaneId = "string",
    InstanceName = "string",
    Consumer = new Konnect.Inputs.GatewayPluginKafkaUpstreamConsumerArgs
    {
        Id = "string",
    },
    CreatedAt = 0,
    Enabled = false,
    GatewayPluginKafkaUpstreamId = "string",
    Config = new Konnect.Inputs.GatewayPluginKafkaUpstreamConfigArgs
    {
        Authentication = new Konnect.Inputs.GatewayPluginKafkaUpstreamConfigAuthenticationArgs
        {
            Mechanism = "string",
            Password = "string",
            Strategy = "string",
            Tokenauth = false,
            User = "string",
        },
        BootstrapServers = new[]
        {
            new Konnect.Inputs.GatewayPluginKafkaUpstreamConfigBootstrapServerArgs
            {
                Host = "string",
                Port = 0,
            },
        },
        ClusterName = "string",
        ForwardBody = false,
        ForwardHeaders = false,
        ForwardMethod = false,
        ForwardUri = false,
        Keepalive = 0,
        KeepaliveEnabled = false,
        ProducerAsync = false,
        ProducerAsyncBufferingLimitsMessagesInMemory = 0,
        ProducerAsyncFlushTimeout = 0,
        ProducerRequestAcks = 0,
        ProducerRequestLimitsBytesPerRequest = 0,
        ProducerRequestLimitsMessagesPerRequest = 0,
        ProducerRequestRetriesBackoffTimeout = 0,
        ProducerRequestRetriesMaxAttempts = 0,
        ProducerRequestTimeout = 0,
        Security = new Konnect.Inputs.GatewayPluginKafkaUpstreamConfigSecurityArgs
        {
            CertificateId = "string",
            Ssl = false,
        },
        Timeout = 0,
        Topic = "string",
    },
    Ordering = new Konnect.Inputs.GatewayPluginKafkaUpstreamOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginKafkaUpstreamOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginKafkaUpstreamOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginKafkaUpstreamRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginKafkaUpstreamServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
});

example, err := konnect.NewGatewayPluginKafkaUpstream(ctx, "gatewayPluginKafkaUpstreamResource", &konnect.GatewayPluginKafkaUpstreamArgs{
ControlPlaneId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Consumer: &.GatewayPluginKafkaUpstreamConsumerArgs{
Id: pulumi.String("string"),
},
CreatedAt: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
GatewayPluginKafkaUpstreamId: pulumi.String("string"),
Config: &.GatewayPluginKafkaUpstreamConfigArgs{
Authentication: &.GatewayPluginKafkaUpstreamConfigAuthenticationArgs{
Mechanism: pulumi.String("string"),
Password: pulumi.String("string"),
Strategy: pulumi.String("string"),
Tokenauth: pulumi.Bool(false),
User: pulumi.String("string"),
},
BootstrapServers: .GatewayPluginKafkaUpstreamConfigBootstrapServerArray{
&.GatewayPluginKafkaUpstreamConfigBootstrapServerArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
ClusterName: pulumi.String("string"),
ForwardBody: pulumi.Bool(false),
ForwardHeaders: pulumi.Bool(false),
ForwardMethod: pulumi.Bool(false),
ForwardUri: pulumi.Bool(false),
Keepalive: pulumi.Float64(0),
KeepaliveEnabled: pulumi.Bool(false),
ProducerAsync: pulumi.Bool(false),
ProducerAsyncBufferingLimitsMessagesInMemory: pulumi.Float64(0),
ProducerAsyncFlushTimeout: pulumi.Float64(0),
ProducerRequestAcks: pulumi.Float64(0),
ProducerRequestLimitsBytesPerRequest: pulumi.Float64(0),
ProducerRequestLimitsMessagesPerRequest: pulumi.Float64(0),
ProducerRequestRetriesBackoffTimeout: pulumi.Float64(0),
ProducerRequestRetriesMaxAttempts: pulumi.Float64(0),
ProducerRequestTimeout: pulumi.Float64(0),
Security: &.GatewayPluginKafkaUpstreamConfigSecurityArgs{
CertificateId: pulumi.String("string"),
Ssl: pulumi.Bool(false),
},
Timeout: pulumi.Float64(0),
Topic: pulumi.String("string"),
},
Ordering: &.GatewayPluginKafkaUpstreamOrderingArgs{
After: &.GatewayPluginKafkaUpstreamOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginKafkaUpstreamOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginKafkaUpstreamRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginKafkaUpstreamServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
})

var gatewayPluginKafkaUpstreamResource = new GatewayPluginKafkaUpstream("gatewayPluginKafkaUpstreamResource", GatewayPluginKafkaUpstreamArgs.builder()
    .controlPlaneId("string")
    .instanceName("string")
    .consumer(GatewayPluginKafkaUpstreamConsumerArgs.builder()
        .id("string")
        .build())
    .createdAt(0)
    .enabled(false)
    .gatewayPluginKafkaUpstreamId("string")
    .config(GatewayPluginKafkaUpstreamConfigArgs.builder()
        .authentication(GatewayPluginKafkaUpstreamConfigAuthenticationArgs.builder()
            .mechanism("string")
            .password("string")
            .strategy("string")
            .tokenauth(false)
            .user("string")
            .build())
        .bootstrapServers(GatewayPluginKafkaUpstreamConfigBootstrapServerArgs.builder()
            .host("string")
            .port(0)
            .build())
        .clusterName("string")
        .forwardBody(false)
        .forwardHeaders(false)
        .forwardMethod(false)
        .forwardUri(false)
        .keepalive(0)
        .keepaliveEnabled(false)
        .producerAsync(false)
        .producerAsyncBufferingLimitsMessagesInMemory(0)
        .producerAsyncFlushTimeout(0)
        .producerRequestAcks(0)
        .producerRequestLimitsBytesPerRequest(0)
        .producerRequestLimitsMessagesPerRequest(0)
        .producerRequestRetriesBackoffTimeout(0)
        .producerRequestRetriesMaxAttempts(0)
        .producerRequestTimeout(0)
        .security(GatewayPluginKafkaUpstreamConfigSecurityArgs.builder()
            .certificateId("string")
            .ssl(false)
            .build())
        .timeout(0)
        .topic("string")
        .build())
    .ordering(GatewayPluginKafkaUpstreamOrderingArgs.builder()
        .after(GatewayPluginKafkaUpstreamOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginKafkaUpstreamOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginKafkaUpstreamRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginKafkaUpstreamServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .updatedAt(0)
    .build());

gateway_plugin_kafka_upstream_resource = konnect.GatewayPluginKafkaUpstream("gatewayPluginKafkaUpstreamResource",
    control_plane_id="string",
    instance_name="string",
    consumer={
        "id": "string",
    },
    created_at=0,
    enabled=False,
    gateway_plugin_kafka_upstream_id="string",
    config={
        "authentication": {
            "mechanism": "string",
            "password": "string",
            "strategy": "string",
            "tokenauth": False,
            "user": "string",
        },
        "bootstrap_servers": [{
            "host": "string",
            "port": 0,
        }],
        "cluster_name": "string",
        "forward_body": False,
        "forward_headers": False,
        "forward_method": False,
        "forward_uri": False,
        "keepalive": 0,
        "keepalive_enabled": False,
        "producer_async": False,
        "producer_async_buffering_limits_messages_in_memory": 0,
        "producer_async_flush_timeout": 0,
        "producer_request_acks": 0,
        "producer_request_limits_bytes_per_request": 0,
        "producer_request_limits_messages_per_request": 0,
        "producer_request_retries_backoff_timeout": 0,
        "producer_request_retries_max_attempts": 0,
        "producer_request_timeout": 0,
        "security": {
            "certificate_id": "string",
            "ssl": False,
        },
        "timeout": 0,
        "topic": "string",
    },
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"],
    updated_at=0)

const gatewayPluginKafkaUpstreamResource = new konnect.GatewayPluginKafkaUpstream("gatewayPluginKafkaUpstreamResource", {
    controlPlaneId: "string",
    instanceName: "string",
    consumer: {
        id: "string",
    },
    createdAt: 0,
    enabled: false,
    gatewayPluginKafkaUpstreamId: "string",
    config: {
        authentication: {
            mechanism: "string",
            password: "string",
            strategy: "string",
            tokenauth: false,
            user: "string",
        },
        bootstrapServers: [{
            host: "string",
            port: 0,
        }],
        clusterName: "string",
        forwardBody: false,
        forwardHeaders: false,
        forwardMethod: false,
        forwardUri: false,
        keepalive: 0,
        keepaliveEnabled: false,
        producerAsync: false,
        producerAsyncBufferingLimitsMessagesInMemory: 0,
        producerAsyncFlushTimeout: 0,
        producerRequestAcks: 0,
        producerRequestLimitsBytesPerRequest: 0,
        producerRequestLimitsMessagesPerRequest: 0,
        producerRequestRetriesBackoffTimeout: 0,
        producerRequestRetriesMaxAttempts: 0,
        producerRequestTimeout: 0,
        security: {
            certificateId: "string",
            ssl: false,
        },
        timeout: 0,
        topic: "string",
    },
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
    updatedAt: 0,
});

type: konnect:GatewayPluginKafkaUpstream
properties:
    config:
        authentication:
            mechanism: string
            password: string
            strategy: string
            tokenauth: false
            user: string
        bootstrapServers:
            - host: string
              port: 0
        clusterName: string
        forwardBody: false
        forwardHeaders: false
        forwardMethod: false
        forwardUri: false
        keepalive: 0
        keepaliveEnabled: false
        producerAsync: false
        producerAsyncBufferingLimitsMessagesInMemory: 0
        producerAsyncFlushTimeout: 0
        producerRequestAcks: 0
        producerRequestLimitsBytesPerRequest: 0
        producerRequestLimitsMessagesPerRequest: 0
        producerRequestRetriesBackoffTimeout: 0
        producerRequestRetriesMaxAttempts: 0
        producerRequestTimeout: 0
        security:
            certificateId: string
            ssl: false
        timeout: 0
        topic: string
    consumer:
        id: string
    controlPlaneId: string
    createdAt: 0
    enabled: false
    gatewayPluginKafkaUpstreamId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
    updatedAt: 0

GatewayPluginKafkaUpstream Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GatewayPluginKafkaUpstream resource accepts the following input properties:

ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config GatewayPluginKafkaUpstreamConfig
Consumer GatewayPluginKafkaUpstreamConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
CreatedAt double: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginKafkaUpstreamId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginKafkaUpstreamOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginKafkaUpstreamRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginKafkaUpstreamService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt double: Unix epoch when the resource was last updated.

ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config GatewayPluginKafkaUpstreamConfigArgs
Consumer GatewayPluginKafkaUpstreamConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
CreatedAt float64: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginKafkaUpstreamId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginKafkaUpstreamOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginKafkaUpstreamRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginKafkaUpstreamServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt float64: Unix epoch when the resource was last updated.

controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginKafkaUpstreamConfig
consumer GatewayPluginKafkaUpstreamConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
createdAt Double: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginKafkaUpstreamId String: The ID of this resource.
instanceName String
ordering GatewayPluginKafkaUpstreamOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginKafkaUpstreamRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginKafkaUpstreamService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Double: Unix epoch when the resource was last updated.

controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginKafkaUpstreamConfig
consumer GatewayPluginKafkaUpstreamConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
createdAt number: Unix epoch when the resource was created.
enabled boolean: Whether the plugin is applied.
gatewayPluginKafkaUpstreamId string: The ID of this resource.
instanceName string
ordering GatewayPluginKafkaUpstreamOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginKafkaUpstreamRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginKafkaUpstreamService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt number: Unix epoch when the resource was last updated.

control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginKafkaUpstreamConfigArgs
consumer GatewayPluginKafkaUpstreamConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
created_at float: Unix epoch when the resource was created.
enabled bool: Whether the plugin is applied.
gateway_plugin_kafka_upstream_id str: The ID of this resource.
instance_name str
ordering GatewayPluginKafkaUpstreamOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginKafkaUpstreamRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginKafkaUpstreamServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float: Unix epoch when the resource was last updated.

controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config Property Map
consumer Property Map: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
createdAt Number: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginKafkaUpstreamId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A set of strings representing HTTP protocols.
route Property Map: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number: Unix epoch when the resource was last updated.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayPluginKafkaUpstream resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing GatewayPluginKafkaUpstream Resource

Get an existing GatewayPluginKafkaUpstream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GatewayPluginKafkaUpstreamState, opts?: CustomResourceOptions): GatewayPluginKafkaUpstream

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginKafkaUpstreamConfigArgs] = None,
        consumer: Optional[GatewayPluginKafkaUpstreamConsumerArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_kafka_upstream_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginKafkaUpstreamOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginKafkaUpstreamRouteArgs] = None,
        service: Optional[GatewayPluginKafkaUpstreamServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginKafkaUpstream

func GetGatewayPluginKafkaUpstream(ctx *Context, name string, id IDInput, state *GatewayPluginKafkaUpstreamState, opts ...ResourceOption) (*GatewayPluginKafkaUpstream, error)

public static GatewayPluginKafkaUpstream Get(string name, Input<string> id, GatewayPluginKafkaUpstreamState? state, CustomResourceOptions? opts = null)

public static GatewayPluginKafkaUpstream get(String name, Output<String> id, GatewayPluginKafkaUpstreamState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginKafkaUpstream    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Config GatewayPluginKafkaUpstreamConfig
Consumer GatewayPluginKafkaUpstreamConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginKafkaUpstreamId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginKafkaUpstreamOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginKafkaUpstreamRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginKafkaUpstreamService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt double: Unix epoch when the resource was last updated.

Config GatewayPluginKafkaUpstreamConfigArgs
Consumer GatewayPluginKafkaUpstreamConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginKafkaUpstreamId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginKafkaUpstreamOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginKafkaUpstreamRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginKafkaUpstreamServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt float64: Unix epoch when the resource was last updated.

config GatewayPluginKafkaUpstreamConfig
consumer GatewayPluginKafkaUpstreamConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginKafkaUpstreamId String: The ID of this resource.
instanceName String
ordering GatewayPluginKafkaUpstreamOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginKafkaUpstreamRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginKafkaUpstreamService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Double: Unix epoch when the resource was last updated.

config GatewayPluginKafkaUpstreamConfig
consumer GatewayPluginKafkaUpstreamConsumer: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number: Unix epoch when the resource was created.
enabled boolean: Whether the plugin is applied.
gatewayPluginKafkaUpstreamId string: The ID of this resource.
instanceName string
ordering GatewayPluginKafkaUpstreamOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginKafkaUpstreamRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginKafkaUpstreamService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt number: Unix epoch when the resource was last updated.

config GatewayPluginKafkaUpstreamConfigArgs
consumer GatewayPluginKafkaUpstreamConsumerArgs: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
created_at float: Unix epoch when the resource was created.
enabled bool: Whether the plugin is applied.
gateway_plugin_kafka_upstream_id str: The ID of this resource.
instance_name str
ordering GatewayPluginKafkaUpstreamOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginKafkaUpstreamRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginKafkaUpstreamServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float: Unix epoch when the resource was last updated.

config Property Map
consumer Property Map: If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginKafkaUpstreamId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A set of strings representing HTTP protocols.
route Property Map: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number: Unix epoch when the resource was last updated.

Supporting Types

GatewayPluginKafkaUpstreamConfig, GatewayPluginKafkaUpstreamConfigArgs

Authentication GatewayPluginKafkaUpstreamConfigAuthentication
BootstrapServers List<GatewayPluginKafkaUpstreamConfigBootstrapServer>: 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). must be one of ["-1", "0", "1"]
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 GatewayPluginKafkaUpstreamConfigSecurity
Timeout double: Socket timeout in milliseconds.
Topic string: The Kafka topic to publish to.

Authentication GatewayPluginKafkaUpstreamConfigAuthentication
BootstrapServers []GatewayPluginKafkaUpstreamConfigBootstrapServer: 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). must be one of ["-1", "0", "1"]
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 GatewayPluginKafkaUpstreamConfigSecurity
Timeout float64: Socket timeout in milliseconds.
Topic string: The Kafka topic to publish to.

authentication GatewayPluginKafkaUpstreamConfigAuthentication
bootstrapServers List<GatewayPluginKafkaUpstreamConfigBootstrapServer>: 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). must be one of ["-1", "0", "1"]
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 GatewayPluginKafkaUpstreamConfigSecurity
timeout Double: Socket timeout in milliseconds.
topic String: The Kafka topic to publish to.

authentication GatewayPluginKafkaUpstreamConfigAuthentication
bootstrapServers GatewayPluginKafkaUpstreamConfigBootstrapServer[]: 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). must be one of ["-1", "0", "1"]
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 GatewayPluginKafkaUpstreamConfigSecurity
timeout number: Socket timeout in milliseconds.
topic string: The Kafka topic to publish to.

authentication GatewayPluginKafkaUpstreamConfigAuthentication
bootstrap_servers Sequence[GatewayPluginKafkaUpstreamConfigBootstrapServer]: 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). must be one of ["-1", "0", "1"]
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 GatewayPluginKafkaUpstreamConfigSecurity
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). must be one of ["-1", "0", "1"]
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.

GatewayPluginKafkaUpstreamConfigAuthentication, GatewayPluginKafkaUpstreamConfigAuthenticationArgs

Mechanism string: The SASL authentication mechanism. Supported options: PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512. must be one of ["PLAIN", "SCRAM-SHA-256", "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. must be "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. must be one of ["PLAIN", "SCRAM-SHA-256", "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. must be "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. must be one of ["PLAIN", "SCRAM-SHA-256", "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. must be "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. must be one of ["PLAIN", "SCRAM-SHA-256", "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. must be "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. must be one of ["PLAIN", "SCRAM-SHA-256", "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. must be "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. must be one of ["PLAIN", "SCRAM-SHA-256", "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. must be "sasl"
tokenauth Boolean: Enable this to indicate DelegationToken authentication.
user String: Username for SASL authentication.

GatewayPluginKafkaUpstreamConfigBootstrapServer, GatewayPluginKafkaUpstreamConfigBootstrapServerArgs

Host string: A string representing a host name, such as example.com. Not Null
Port double: An integer representing a port number between 0 and 65535, inclusive. Not Null

Host string: A string representing a host name, such as example.com. Not Null
Port float64: An integer representing a port number between 0 and 65535, inclusive. Not Null

host String: A string representing a host name, such as example.com. Not Null
port Double: An integer representing a port number between 0 and 65535, inclusive. Not Null

host string: A string representing a host name, such as example.com. Not Null
port number: An integer representing a port number between 0 and 65535, inclusive. Not Null

host str: A string representing a host name, such as example.com. Not Null
port float: An integer representing a port number between 0 and 65535, inclusive. Not Null

host String: A string representing a host name, such as example.com. Not Null
port Number: An integer representing a port number between 0 and 65535, inclusive. Not Null

GatewayPluginKafkaUpstreamConfigSecurity, GatewayPluginKafkaUpstreamConfigSecurityArgs

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.

GatewayPluginKafkaUpstreamConsumer, GatewayPluginKafkaUpstreamConsumerArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginKafkaUpstreamOrdering, GatewayPluginKafkaUpstreamOrderingArgs

After GatewayPluginKafkaUpstreamOrderingAfter
Before GatewayPluginKafkaUpstreamOrderingBefore

After GatewayPluginKafkaUpstreamOrderingAfter
Before GatewayPluginKafkaUpstreamOrderingBefore

after GatewayPluginKafkaUpstreamOrderingAfter
before GatewayPluginKafkaUpstreamOrderingBefore

after GatewayPluginKafkaUpstreamOrderingAfter
before GatewayPluginKafkaUpstreamOrderingBefore

after GatewayPluginKafkaUpstreamOrderingAfter
before GatewayPluginKafkaUpstreamOrderingBefore

after Property Map
before Property Map

GatewayPluginKafkaUpstreamOrderingAfter, GatewayPluginKafkaUpstreamOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginKafkaUpstreamOrderingBefore, GatewayPluginKafkaUpstreamOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginKafkaUpstreamRoute, GatewayPluginKafkaUpstreamRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginKafkaUpstreamService, GatewayPluginKafkaUpstreamServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginKafkaUpstream:GatewayPluginKafkaUpstream my_konnect_gateway_plugin_kafka_upstream "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"

To learn more about importing existing cloud resources, see Importing resources.

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.GatewayPluginKafkaUpstream

On this page

On this page

Example Usage

Create GatewayPluginKafkaUpstream Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginKafkaUpstream Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginKafkaUpstream Resource

Supporting Types

GatewayPluginKafkaUpstreamConfig, GatewayPluginKafkaUpstreamConfigArgs

GatewayPluginKafkaUpstreamConfigAuthentication, GatewayPluginKafkaUpstreamConfigAuthenticationArgs

GatewayPluginKafkaUpstreamConfigBootstrapServer, GatewayPluginKafkaUpstreamConfigBootstrapServerArgs

GatewayPluginKafkaUpstreamConfigSecurity, GatewayPluginKafkaUpstreamConfigSecurityArgs

GatewayPluginKafkaUpstreamConsumer, GatewayPluginKafkaUpstreamConsumerArgs

GatewayPluginKafkaUpstreamOrdering, GatewayPluginKafkaUpstreamOrderingArgs

GatewayPluginKafkaUpstreamOrderingAfter, GatewayPluginKafkaUpstreamOrderingAfterArgs

GatewayPluginKafkaUpstreamOrderingBefore, GatewayPluginKafkaUpstreamOrderingBeforeArgs

GatewayPluginKafkaUpstreamRoute, GatewayPluginKafkaUpstreamRouteArgs

GatewayPluginKafkaUpstreamService, GatewayPluginKafkaUpstreamServiceArgs

Import

Package Details

On this page

On this page