konnect 2.7.3, May 13 25

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

konnect.GatewayPluginConfluentConsume

Explore with Pulumi AI

konnect 2.7.3 published on Tuesday, May 13, 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.GatewayPluginConfluentConsume;
import com.pulumi.konnect.GatewayPluginConfluentConsumeArgs;
import com.pulumi.konnect.inputs.GatewayPluginConfluentConsumeConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginConfluentConsumeConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginConfluentConsumeOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginConfluentConsumeOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginConfluentConsumeOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginConfluentConsumeRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginConfluentConsumeServiceArgs;
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 myGatewaypluginconfluentconsume = new GatewayPluginConfluentConsume("myGatewaypluginconfluentconsume", GatewayPluginConfluentConsumeArgs.builder()
            .config(GatewayPluginConfluentConsumeConfigArgs.builder()
                .auto_offset_reset("earliest")
                .bootstrap_servers(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .cluster_api_key("...my_cluster_api_key...")
                .cluster_api_secret("...my_cluster_api_secret...")
                .cluster_name("...my_cluster_name...")
                .commit_strategy("auto")
                .confluent_cloud_api_key("...my_confluent_cloud_api_key...")
                .confluent_cloud_api_secret("...my_confluent_cloud_api_secret...")
                .keepalive(2)
                .keepalive_enabled(true)
                .message_deserializer("noop")
                .mode("http-get")
                .timeout(7)
                .topics(GatewayPluginConfluentConsumeConfigTopicArgs.builder()
                    .name("...my_name...")
                    .build())
                .build())
            .consumer(GatewayPluginConfluentConsumeConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(6)
            .enabled(true)
            .gatewayPluginConfluentConsumeId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginConfluentConsumeOrderingArgs.builder()
                .after(GatewayPluginConfluentConsumeOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginConfluentConsumeOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("https")
            .route(GatewayPluginConfluentConsumeRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginConfluentConsumeServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .updatedAt(0)
            .build());

    }
}

resources:
  myGatewaypluginconfluentconsume:
    type: konnect:GatewayPluginConfluentConsume
    properties:
      config:
        auto_offset_reset: earliest
        bootstrap_servers:
          - host: '...my_host...'
            port: 58521
        cluster_api_key: '...my_cluster_api_key...'
        cluster_api_secret: '...my_cluster_api_secret...'
        cluster_name: '...my_cluster_name...'
        commit_strategy: auto
        confluent_cloud_api_key: '...my_confluent_cloud_api_key...'
        confluent_cloud_api_secret: '...my_confluent_cloud_api_secret...'
        keepalive: 2
        keepalive_enabled: true
        message_deserializer: noop
        mode: http-get
        timeout: 7
        topics:
          - name: '...my_name...'
      consumer:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 6
      enabled: true
      gatewayPluginConfluentConsumeId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - https
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
      updatedAt: 0

Create GatewayPluginConfluentConsume Resource

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

Constructor syntax

new GatewayPluginConfluentConsume(name: string, args: GatewayPluginConfluentConsumeArgs, opts?: CustomResourceOptions);

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

@overload
def GatewayPluginConfluentConsume(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  control_plane_id: Optional[str] = None,
                                  instance_name: Optional[str] = None,
                                  consumer: Optional[GatewayPluginConfluentConsumeConsumerArgs] = None,
                                  created_at: Optional[float] = None,
                                  enabled: Optional[bool] = None,
                                  gateway_plugin_confluent_consume_id: Optional[str] = None,
                                  config: Optional[GatewayPluginConfluentConsumeConfigArgs] = None,
                                  ordering: Optional[GatewayPluginConfluentConsumeOrderingArgs] = None,
                                  protocols: Optional[Sequence[str]] = None,
                                  route: Optional[GatewayPluginConfluentConsumeRouteArgs] = None,
                                  service: Optional[GatewayPluginConfluentConsumeServiceArgs] = None,
                                  tags: Optional[Sequence[str]] = None,
                                  updated_at: Optional[float] = None)

func NewGatewayPluginConfluentConsume(ctx *Context, name string, args GatewayPluginConfluentConsumeArgs, opts ...ResourceOption) (*GatewayPluginConfluentConsume, error)

public GatewayPluginConfluentConsume(string name, GatewayPluginConfluentConsumeArgs args, CustomResourceOptions? opts = null)

public GatewayPluginConfluentConsume(String name, GatewayPluginConfluentConsumeArgs args)
public GatewayPluginConfluentConsume(String name, GatewayPluginConfluentConsumeArgs args, CustomResourceOptions options)

type: konnect:GatewayPluginConfluentConsume
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 GatewayPluginConfluentConsumeArgs: 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 GatewayPluginConfluentConsumeArgs: 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 GatewayPluginConfluentConsumeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args GatewayPluginConfluentConsumeArgs: 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 gatewayPluginConfluentConsumeResource = new Konnect.GatewayPluginConfluentConsume("gatewayPluginConfluentConsumeResource", new()
{
    ControlPlaneId = "string",
    InstanceName = "string",
    Consumer = new Konnect.Inputs.GatewayPluginConfluentConsumeConsumerArgs
    {
        Id = "string",
    },
    CreatedAt = 0,
    Enabled = false,
    GatewayPluginConfluentConsumeId = "string",
    Config = new Konnect.Inputs.GatewayPluginConfluentConsumeConfigArgs
    {
        AutoOffsetReset = "string",
        BootstrapServers = new[]
        {
            new Konnect.Inputs.GatewayPluginConfluentConsumeConfigBootstrapServerArgs
            {
                Host = "string",
                Port = 0,
            },
        },
        ClusterApiKey = "string",
        ClusterApiSecret = "string",
        ClusterName = "string",
        CommitStrategy = "string",
        ConfluentCloudApiKey = "string",
        ConfluentCloudApiSecret = "string",
        Keepalive = 0,
        KeepaliveEnabled = false,
        MessageDeserializer = "string",
        Mode = "string",
        Timeout = 0,
        Topics = new[]
        {
            new Konnect.Inputs.GatewayPluginConfluentConsumeConfigTopicArgs
            {
                Name = "string",
            },
        },
    },
    Ordering = new Konnect.Inputs.GatewayPluginConfluentConsumeOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginConfluentConsumeOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginConfluentConsumeOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginConfluentConsumeRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginConfluentConsumeServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
});

example, err := konnect.NewGatewayPluginConfluentConsume(ctx, "gatewayPluginConfluentConsumeResource", &konnect.GatewayPluginConfluentConsumeArgs{
	ControlPlaneId: pulumi.String("string"),
	InstanceName:   pulumi.String("string"),
	Consumer: &konnect.GatewayPluginConfluentConsumeConsumerArgs{
		Id: pulumi.String("string"),
	},
	CreatedAt:                       pulumi.Float64(0),
	Enabled:                         pulumi.Bool(false),
	GatewayPluginConfluentConsumeId: pulumi.String("string"),
	Config: &konnect.GatewayPluginConfluentConsumeConfigArgs{
		AutoOffsetReset: pulumi.String("string"),
		BootstrapServers: konnect.GatewayPluginConfluentConsumeConfigBootstrapServerArray{
			&konnect.GatewayPluginConfluentConsumeConfigBootstrapServerArgs{
				Host: pulumi.String("string"),
				Port: pulumi.Float64(0),
			},
		},
		ClusterApiKey:           pulumi.String("string"),
		ClusterApiSecret:        pulumi.String("string"),
		ClusterName:             pulumi.String("string"),
		CommitStrategy:          pulumi.String("string"),
		ConfluentCloudApiKey:    pulumi.String("string"),
		ConfluentCloudApiSecret: pulumi.String("string"),
		Keepalive:               pulumi.Float64(0),
		KeepaliveEnabled:        pulumi.Bool(false),
		MessageDeserializer:     pulumi.String("string"),
		Mode:                    pulumi.String("string"),
		Timeout:                 pulumi.Float64(0),
		Topics: konnect.GatewayPluginConfluentConsumeConfigTopicArray{
			&konnect.GatewayPluginConfluentConsumeConfigTopicArgs{
				Name: pulumi.String("string"),
			},
		},
	},
	Ordering: &konnect.GatewayPluginConfluentConsumeOrderingArgs{
		After: &konnect.GatewayPluginConfluentConsumeOrderingAfterArgs{
			Accesses: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Before: &konnect.GatewayPluginConfluentConsumeOrderingBeforeArgs{
			Accesses: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	Route: &konnect.GatewayPluginConfluentConsumeRouteArgs{
		Id: pulumi.String("string"),
	},
	Service: &konnect.GatewayPluginConfluentConsumeServiceArgs{
		Id: pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UpdatedAt: pulumi.Float64(0),
})

var gatewayPluginConfluentConsumeResource = new GatewayPluginConfluentConsume("gatewayPluginConfluentConsumeResource", GatewayPluginConfluentConsumeArgs.builder()
    .controlPlaneId("string")
    .instanceName("string")
    .consumer(GatewayPluginConfluentConsumeConsumerArgs.builder()
        .id("string")
        .build())
    .createdAt(0.0)
    .enabled(false)
    .gatewayPluginConfluentConsumeId("string")
    .config(GatewayPluginConfluentConsumeConfigArgs.builder()
        .autoOffsetReset("string")
        .bootstrapServers(GatewayPluginConfluentConsumeConfigBootstrapServerArgs.builder()
            .host("string")
            .port(0.0)
            .build())
        .clusterApiKey("string")
        .clusterApiSecret("string")
        .clusterName("string")
        .commitStrategy("string")
        .confluentCloudApiKey("string")
        .confluentCloudApiSecret("string")
        .keepalive(0.0)
        .keepaliveEnabled(false)
        .messageDeserializer("string")
        .mode("string")
        .timeout(0.0)
        .topics(GatewayPluginConfluentConsumeConfigTopicArgs.builder()
            .name("string")
            .build())
        .build())
    .ordering(GatewayPluginConfluentConsumeOrderingArgs.builder()
        .after(GatewayPluginConfluentConsumeOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginConfluentConsumeOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginConfluentConsumeRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginConfluentConsumeServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .updatedAt(0.0)
    .build());

gateway_plugin_confluent_consume_resource = konnect.GatewayPluginConfluentConsume("gatewayPluginConfluentConsumeResource",
    control_plane_id="string",
    instance_name="string",
    consumer={
        "id": "string",
    },
    created_at=0,
    enabled=False,
    gateway_plugin_confluent_consume_id="string",
    config={
        "auto_offset_reset": "string",
        "bootstrap_servers": [{
            "host": "string",
            "port": 0,
        }],
        "cluster_api_key": "string",
        "cluster_api_secret": "string",
        "cluster_name": "string",
        "commit_strategy": "string",
        "confluent_cloud_api_key": "string",
        "confluent_cloud_api_secret": "string",
        "keepalive": 0,
        "keepalive_enabled": False,
        "message_deserializer": "string",
        "mode": "string",
        "timeout": 0,
        "topics": [{
            "name": "string",
        }],
    },
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"],
    updated_at=0)

const gatewayPluginConfluentConsumeResource = new konnect.GatewayPluginConfluentConsume("gatewayPluginConfluentConsumeResource", {
    controlPlaneId: "string",
    instanceName: "string",
    consumer: {
        id: "string",
    },
    createdAt: 0,
    enabled: false,
    gatewayPluginConfluentConsumeId: "string",
    config: {
        autoOffsetReset: "string",
        bootstrapServers: [{
            host: "string",
            port: 0,
        }],
        clusterApiKey: "string",
        clusterApiSecret: "string",
        clusterName: "string",
        commitStrategy: "string",
        confluentCloudApiKey: "string",
        confluentCloudApiSecret: "string",
        keepalive: 0,
        keepaliveEnabled: false,
        messageDeserializer: "string",
        mode: "string",
        timeout: 0,
        topics: [{
            name: "string",
        }],
    },
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
    updatedAt: 0,
});

type: konnect:GatewayPluginConfluentConsume
properties:
    config:
        autoOffsetReset: string
        bootstrapServers:
            - host: string
              port: 0
        clusterApiKey: string
        clusterApiSecret: string
        clusterName: string
        commitStrategy: string
        confluentCloudApiKey: string
        confluentCloudApiSecret: string
        keepalive: 0
        keepaliveEnabled: false
        messageDeserializer: string
        mode: string
        timeout: 0
        topics:
            - name: string
    consumer:
        id: string
    controlPlaneId: string
    createdAt: 0
    enabled: false
    gatewayPluginConfluentConsumeId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
    updatedAt: 0

GatewayPluginConfluentConsume 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 GatewayPluginConfluentConsume 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 GatewayPluginConfluentConsumeConfig
Consumer GatewayPluginConfluentConsumeConsumer: 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.
GatewayPluginConfluentConsumeId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginConfluentConsumeOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginConfluentConsumeRoute: 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 GatewayPluginConfluentConsumeService: 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 GatewayPluginConfluentConsumeConfigArgs
Consumer GatewayPluginConfluentConsumeConsumerArgs: 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.
GatewayPluginConfluentConsumeId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginConfluentConsumeOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginConfluentConsumeRouteArgs: 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 GatewayPluginConfluentConsumeServiceArgs: 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 GatewayPluginConfluentConsumeConfig
consumer GatewayPluginConfluentConsumeConsumer: 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.
gatewayPluginConfluentConsumeId String: The ID of this resource.
instanceName String
ordering GatewayPluginConfluentConsumeOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginConfluentConsumeRoute: 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 GatewayPluginConfluentConsumeService: 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 GatewayPluginConfluentConsumeConfig
consumer GatewayPluginConfluentConsumeConsumer: 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.
gatewayPluginConfluentConsumeId string: The ID of this resource.
instanceName string
ordering GatewayPluginConfluentConsumeOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginConfluentConsumeRoute: 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 GatewayPluginConfluentConsumeService: 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 GatewayPluginConfluentConsumeConfigArgs
consumer GatewayPluginConfluentConsumeConsumerArgs: 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_confluent_consume_id str: The ID of this resource.
instance_name str
ordering GatewayPluginConfluentConsumeOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginConfluentConsumeRouteArgs: 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 GatewayPluginConfluentConsumeServiceArgs: 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.
gatewayPluginConfluentConsumeId 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 GatewayPluginConfluentConsume 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 GatewayPluginConfluentConsume Resource

Get an existing GatewayPluginConfluentConsume 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?: GatewayPluginConfluentConsumeState, opts?: CustomResourceOptions): GatewayPluginConfluentConsume

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginConfluentConsumeConfigArgs] = None,
        consumer: Optional[GatewayPluginConfluentConsumeConsumerArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_confluent_consume_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginConfluentConsumeOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginConfluentConsumeRouteArgs] = None,
        service: Optional[GatewayPluginConfluentConsumeServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginConfluentConsume

func GetGatewayPluginConfluentConsume(ctx *Context, name string, id IDInput, state *GatewayPluginConfluentConsumeState, opts ...ResourceOption) (*GatewayPluginConfluentConsume, error)

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

public static GatewayPluginConfluentConsume get(String name, Output<String> id, GatewayPluginConfluentConsumeState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginConfluentConsume    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 GatewayPluginConfluentConsumeConfig
Consumer GatewayPluginConfluentConsumeConsumer: 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.
GatewayPluginConfluentConsumeId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginConfluentConsumeOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginConfluentConsumeRoute: 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 GatewayPluginConfluentConsumeService: 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 GatewayPluginConfluentConsumeConfigArgs
Consumer GatewayPluginConfluentConsumeConsumerArgs: 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.
GatewayPluginConfluentConsumeId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginConfluentConsumeOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginConfluentConsumeRouteArgs: 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 GatewayPluginConfluentConsumeServiceArgs: 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 GatewayPluginConfluentConsumeConfig
consumer GatewayPluginConfluentConsumeConsumer: 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.
gatewayPluginConfluentConsumeId String: The ID of this resource.
instanceName String
ordering GatewayPluginConfluentConsumeOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginConfluentConsumeRoute: 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 GatewayPluginConfluentConsumeService: 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 GatewayPluginConfluentConsumeConfig
consumer GatewayPluginConfluentConsumeConsumer: 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.
gatewayPluginConfluentConsumeId string: The ID of this resource.
instanceName string
ordering GatewayPluginConfluentConsumeOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginConfluentConsumeRoute: 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 GatewayPluginConfluentConsumeService: 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 GatewayPluginConfluentConsumeConfigArgs
consumer GatewayPluginConfluentConsumeConsumerArgs: 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_confluent_consume_id str: The ID of this resource.
instance_name str
ordering GatewayPluginConfluentConsumeOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginConfluentConsumeRouteArgs: 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 GatewayPluginConfluentConsumeServiceArgs: 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.
gatewayPluginConfluentConsumeId 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

GatewayPluginConfluentConsumeConfig, GatewayPluginConfluentConsumeConfigArgs

AutoOffsetReset string: The offset to start from when there is no initial offset in the consumer group. must be one of ["earliest", "latest"]
BootstrapServers List<GatewayPluginConfluentConsumeConfigBootstrapServer>: 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.
CommitStrategy string: The strategy to use for committing offsets. must be one of ["auto", "off"]
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.
Keepalive double: Keepalive timeout in milliseconds.
KeepaliveEnabled bool
MessageDeserializer string: The deserializer to use for the consumed messages. must be one of ["json", "noop"]
Mode string: The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
Timeout double: Socket timeout in milliseconds.
Topics List<GatewayPluginConfluentConsumeConfigTopic>: The Kafka topics and their configuration you want to consume from.

AutoOffsetReset string: The offset to start from when there is no initial offset in the consumer group. must be one of ["earliest", "latest"]
BootstrapServers []GatewayPluginConfluentConsumeConfigBootstrapServer: 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.
CommitStrategy string: The strategy to use for committing offsets. must be one of ["auto", "off"]
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.
Keepalive float64: Keepalive timeout in milliseconds.
KeepaliveEnabled bool
MessageDeserializer string: The deserializer to use for the consumed messages. must be one of ["json", "noop"]
Mode string: The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
Timeout float64: Socket timeout in milliseconds.
Topics []GatewayPluginConfluentConsumeConfigTopic: The Kafka topics and their configuration you want to consume from.

autoOffsetReset String: The offset to start from when there is no initial offset in the consumer group. must be one of ["earliest", "latest"]
bootstrapServers List<GatewayPluginConfluentConsumeConfigBootstrapServer>: 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.
commitStrategy String: The strategy to use for committing offsets. must be one of ["auto", "off"]
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.
keepalive Double: Keepalive timeout in milliseconds.
keepaliveEnabled Boolean
messageDeserializer String: The deserializer to use for the consumed messages. must be one of ["json", "noop"]
mode String: The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
timeout Double: Socket timeout in milliseconds.
topics List<GatewayPluginConfluentConsumeConfigTopic>: The Kafka topics and their configuration you want to consume from.

autoOffsetReset string: The offset to start from when there is no initial offset in the consumer group. must be one of ["earliest", "latest"]
bootstrapServers GatewayPluginConfluentConsumeConfigBootstrapServer[]: 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.
commitStrategy string: The strategy to use for committing offsets. must be one of ["auto", "off"]
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.
keepalive number: Keepalive timeout in milliseconds.
keepaliveEnabled boolean
messageDeserializer string: The deserializer to use for the consumed messages. must be one of ["json", "noop"]
mode string: The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
timeout number: Socket timeout in milliseconds.
topics GatewayPluginConfluentConsumeConfigTopic[]: The Kafka topics and their configuration you want to consume from.

auto_offset_reset str: The offset to start from when there is no initial offset in the consumer group. must be one of ["earliest", "latest"]
bootstrap_servers Sequence[GatewayPluginConfluentConsumeConfigBootstrapServer]: 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.
commit_strategy str: The strategy to use for committing offsets. must be one of ["auto", "off"]
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.
keepalive float: Keepalive timeout in milliseconds.
keepalive_enabled bool
message_deserializer str: The deserializer to use for the consumed messages. must be one of ["json", "noop"]
mode str: The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
timeout float: Socket timeout in milliseconds.
topics Sequence[GatewayPluginConfluentConsumeConfigTopic]: The Kafka topics and their configuration you want to consume from.

autoOffsetReset String: The offset to start from when there is no initial offset in the consumer group. must be one of ["earliest", "latest"]
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.
commitStrategy String: The strategy to use for committing offsets. must be one of ["auto", "off"]
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.
keepalive Number: Keepalive timeout in milliseconds.
keepaliveEnabled Boolean
messageDeserializer String: The deserializer to use for the consumed messages. must be one of ["json", "noop"]
mode String: The mode of operation for the plugin. must be one of ["http-get", "server-sent-events"]
timeout Number: Socket timeout in milliseconds.
topics List<Property Map>: The Kafka topics and their configuration you want to consume from.

GatewayPluginConfluentConsumeConfigBootstrapServer, GatewayPluginConfluentConsumeConfigBootstrapServerArgs

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

GatewayPluginConfluentConsumeConfigTopic, GatewayPluginConfluentConsumeConfigTopicArgs

Name string: Not Null

Name string: Not Null

name String: Not Null

name string: Not Null

name str: Not Null

name String: Not Null

GatewayPluginConfluentConsumeConsumer, GatewayPluginConfluentConsumeConsumerArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginConfluentConsumeOrdering, GatewayPluginConfluentConsumeOrderingArgs

After GatewayPluginConfluentConsumeOrderingAfter
Before GatewayPluginConfluentConsumeOrderingBefore

After GatewayPluginConfluentConsumeOrderingAfter
Before GatewayPluginConfluentConsumeOrderingBefore

after GatewayPluginConfluentConsumeOrderingAfter
before GatewayPluginConfluentConsumeOrderingBefore

after GatewayPluginConfluentConsumeOrderingAfter
before GatewayPluginConfluentConsumeOrderingBefore

after GatewayPluginConfluentConsumeOrderingAfter
before GatewayPluginConfluentConsumeOrderingBefore

after Property Map
before Property Map

GatewayPluginConfluentConsumeOrderingAfter, GatewayPluginConfluentConsumeOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginConfluentConsumeOrderingBefore, GatewayPluginConfluentConsumeOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginConfluentConsumeRoute, GatewayPluginConfluentConsumeRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginConfluentConsumeService, GatewayPluginConfluentConsumeServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginConfluentConsume:GatewayPluginConfluentConsume my_konnect_gateway_plugin_confluent_consume "{ \"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.7.3 published on Tuesday, May 13, 2025 by kong

kong/terraform-provider-konnect

konnect.GatewayPluginConfluentConsume

On this page

On this page

Example Usage

Create GatewayPluginConfluentConsume Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginConfluentConsume Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginConfluentConsume Resource

Supporting Types

GatewayPluginConfluentConsumeConfig, GatewayPluginConfluentConsumeConfigArgs

GatewayPluginConfluentConsumeConfigBootstrapServer, GatewayPluginConfluentConsumeConfigBootstrapServerArgs

GatewayPluginConfluentConsumeConfigTopic, GatewayPluginConfluentConsumeConfigTopicArgs

GatewayPluginConfluentConsumeConsumer, GatewayPluginConfluentConsumeConsumerArgs

GatewayPluginConfluentConsumeOrdering, GatewayPluginConfluentConsumeOrderingArgs

GatewayPluginConfluentConsumeOrderingAfter, GatewayPluginConfluentConsumeOrderingAfterArgs

GatewayPluginConfluentConsumeOrderingBefore, GatewayPluginConfluentConsumeOrderingBeforeArgs

GatewayPluginConfluentConsumeRoute, GatewayPluginConfluentConsumeRouteArgs

GatewayPluginConfluentConsumeService, GatewayPluginConfluentConsumeServiceArgs

Import

Package Details

On this page

On this page