1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginKafkaConsume
konnect 3.0.0 published on Friday, Aug 22, 2025 by kong

konnect.GatewayPluginKafkaConsume

Explore with Pulumi AI

konnect logo
konnect 3.0.0 published on Friday, Aug 22, 2025 by kong

    GatewayPluginKafkaConsume Resource

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.GatewayPluginKafkaConsume;
    import com.pulumi.konnect.GatewayPluginKafkaConsumeArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeConfigArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeConfigAuthenticationArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeConfigSecurityArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeConsumerArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeOrderingArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeOrderingAfterArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeOrderingBeforeArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumePartialArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeRouteArgs;
    import com.pulumi.konnect.inputs.GatewayPluginKafkaConsumeServiceArgs;
    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 myGatewaypluginkafkaconsume = new GatewayPluginKafkaConsume("myGatewaypluginkafkaconsume", GatewayPluginKafkaConsumeArgs.builder()
                .config(GatewayPluginKafkaConsumeConfigArgs.builder()
                    .authentication(GatewayPluginKafkaConsumeConfigAuthenticationArgs.builder()
                        .mechanism("SCRAM-SHA-512")
                        .password("...my_password...")
                        .strategy("sasl")
                        .tokenauth(true)
                        .user("...my_user...")
                        .build())
                    .auto_offset_reset("earliest")
                    .bootstrap_servers(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .cluster_name("...my_cluster_name...")
                    .commit_strategy("off")
                    .message_deserializer("noop")
                    .mode("websocket")
                    .schema_registry(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .security(GatewayPluginKafkaConsumeConfigSecurityArgs.builder()
                        .certificateId("...my_certificate_id...")
                        .ssl(true)
                        .build())
                    .topics(GatewayPluginKafkaConsumeConfigTopicArgs.builder()
                        .name("...my_name...")
                        .schemaRegistry(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs.builder()
                            .confluent(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs.builder()
                                .authentication(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs.builder()
                                    .basic(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs.builder()
                                        .password("...my_password...")
                                        .username("...my_username...")
                                        .build())
                                    .mode("basic")
                                    .build())
                                .sslVerify(true)
                                .ttl(2977.64)
                                .url("...my_url...")
                                .build())
                            .build())
                        .build())
                    .build())
                .consumer(GatewayPluginKafkaConsumeConsumerArgs.builder()
                    .id("...my_id...")
                    .build())
                .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
                .createdAt(0)
                .enabled(false)
                .gatewayPluginKafkaConsumeId("...my_id...")
                .instanceName("...my_instance_name...")
                .ordering(GatewayPluginKafkaConsumeOrderingArgs.builder()
                    .after(GatewayPluginKafkaConsumeOrderingAfterArgs.builder()
                        .access("...")
                        .build())
                    .before(GatewayPluginKafkaConsumeOrderingBeforeArgs.builder()
                        .access("...")
                        .build())
                    .build())
                .partials(GatewayPluginKafkaConsumePartialArgs.builder()
                    .id("...my_id...")
                    .name("...my_name...")
                    .path("...my_path...")
                    .build())
                .protocols("wss")
                .route(GatewayPluginKafkaConsumeRouteArgs.builder()
                    .id("...my_id...")
                    .build())
                .service(GatewayPluginKafkaConsumeServiceArgs.builder()
                    .id("...my_id...")
                    .build())
                .tags("...")
                .updatedAt(0)
                .build());
    
        }
    }
    
    resources:
      myGatewaypluginkafkaconsume:
        type: konnect:GatewayPluginKafkaConsume
        properties:
          config:
            authentication:
              mechanism: SCRAM-SHA-512
              password: '...my_password...'
              strategy: sasl
              tokenauth: true
              user: '...my_user...'
            auto_offset_reset: earliest
            bootstrap_servers:
              - host: '...my_host...'
                port: 27325
            cluster_name: '...my_cluster_name...'
            commit_strategy: off
            message_deserializer: noop
            mode: websocket
            schema_registry:
              confluent:
                authentication:
                  basic:
                    password: '...my_password...'
                    username: '...my_username...'
                  mode: none
                sslVerify: false
                ttl: 1981.8
                url: '...my_url...'
            security:
              certificateId: '...my_certificate_id...'
              ssl: true
            topics:
              - name: '...my_name...'
                schemaRegistry:
                  confluent:
                    authentication:
                      basic:
                        password: '...my_password...'
                        username: '...my_username...'
                      mode: basic
                    sslVerify: true
                    ttl: 2977.64
                    url: '...my_url...'
          consumer:
            id: '...my_id...'
          controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
          createdAt: 0
          enabled: false
          gatewayPluginKafkaConsumeId: '...my_id...'
          instanceName: '...my_instance_name...'
          ordering:
            after:
              access:
                - '...'
            before:
              access:
                - '...'
          partials:
            - id: '...my_id...'
              name: '...my_name...'
              path: '...my_path...'
          protocols:
            - wss
          route:
            id: '...my_id...'
          service:
            id: '...my_id...'
          tags:
            - '...'
          updatedAt: 0
    

    Create GatewayPluginKafkaConsume Resource

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

    Constructor syntax

    new GatewayPluginKafkaConsume(name: string, args: GatewayPluginKafkaConsumeArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayPluginKafkaConsume(resource_name: str,
                                  args: GatewayPluginKafkaConsumeArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayPluginKafkaConsume(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  control_plane_id: Optional[str] = None,
                                  config: Optional[GatewayPluginKafkaConsumeConfigArgs] = None,
                                  instance_name: Optional[str] = None,
                                  created_at: Optional[float] = None,
                                  enabled: Optional[bool] = None,
                                  gateway_plugin_kafka_consume_id: Optional[str] = None,
                                  consumer: Optional[GatewayPluginKafkaConsumeConsumerArgs] = None,
                                  ordering: Optional[GatewayPluginKafkaConsumeOrderingArgs] = None,
                                  partials: Optional[Sequence[GatewayPluginKafkaConsumePartialArgs]] = None,
                                  protocols: Optional[Sequence[str]] = None,
                                  route: Optional[GatewayPluginKafkaConsumeRouteArgs] = None,
                                  service: Optional[GatewayPluginKafkaConsumeServiceArgs] = None,
                                  tags: Optional[Sequence[str]] = None,
                                  updated_at: Optional[float] = None)
    func NewGatewayPluginKafkaConsume(ctx *Context, name string, args GatewayPluginKafkaConsumeArgs, opts ...ResourceOption) (*GatewayPluginKafkaConsume, error)
    public GatewayPluginKafkaConsume(string name, GatewayPluginKafkaConsumeArgs args, CustomResourceOptions? opts = null)
    public GatewayPluginKafkaConsume(String name, GatewayPluginKafkaConsumeArgs args)
    public GatewayPluginKafkaConsume(String name, GatewayPluginKafkaConsumeArgs args, CustomResourceOptions options)
    
    type: konnect:GatewayPluginKafkaConsume
    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 GatewayPluginKafkaConsumeArgs
    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 GatewayPluginKafkaConsumeArgs
    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 GatewayPluginKafkaConsumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayPluginKafkaConsumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayPluginKafkaConsumeArgs
    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 gatewayPluginKafkaConsumeResource = new Konnect.GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource", new()
    {
        ControlPlaneId = "string",
        Config = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigArgs
        {
            BootstrapServers = new[]
            {
                new Konnect.Inputs.GatewayPluginKafkaConsumeConfigBootstrapServerArgs
                {
                    Host = "string",
                    Port = 0,
                },
            },
            Topics = new[]
            {
                new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicArgs
                {
                    Name = "string",
                    SchemaRegistry = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs
                    {
                        Confluent = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs
                        {
                            Authentication = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs
                            {
                                Basic = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs
                                {
                                    Password = "string",
                                    Username = "string",
                                },
                                Mode = "string",
                            },
                            SslVerify = false,
                            Ttl = 0,
                            Url = "string",
                        },
                    },
                },
            },
            Authentication = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigAuthenticationArgs
            {
                Mechanism = "string",
                Password = "string",
                Strategy = "string",
                Tokenauth = false,
                User = "string",
            },
            AutoOffsetReset = "string",
            ClusterName = "string",
            CommitStrategy = "string",
            MessageDeserializer = "string",
            Mode = "string",
            SchemaRegistry = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryArgs
            {
                Confluent = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentArgs
                {
                    Authentication = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationArgs
                    {
                        Basic = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasicArgs
                        {
                            Password = "string",
                            Username = "string",
                        },
                        Mode = "string",
                    },
                    SslVerify = false,
                    Ttl = 0,
                    Url = "string",
                },
            },
            Security = new Konnect.Inputs.GatewayPluginKafkaConsumeConfigSecurityArgs
            {
                CertificateId = "string",
                Ssl = false,
            },
        },
        InstanceName = "string",
        CreatedAt = 0,
        Enabled = false,
        GatewayPluginKafkaConsumeId = "string",
        Consumer = new Konnect.Inputs.GatewayPluginKafkaConsumeConsumerArgs
        {
            Id = "string",
        },
        Ordering = new Konnect.Inputs.GatewayPluginKafkaConsumeOrderingArgs
        {
            After = new Konnect.Inputs.GatewayPluginKafkaConsumeOrderingAfterArgs
            {
                Accesses = new[]
                {
                    "string",
                },
            },
            Before = new Konnect.Inputs.GatewayPluginKafkaConsumeOrderingBeforeArgs
            {
                Accesses = new[]
                {
                    "string",
                },
            },
        },
        Partials = new[]
        {
            new Konnect.Inputs.GatewayPluginKafkaConsumePartialArgs
            {
                Id = "string",
                Name = "string",
                Path = "string",
            },
        },
        Protocols = new[]
        {
            "string",
        },
        Route = new Konnect.Inputs.GatewayPluginKafkaConsumeRouteArgs
        {
            Id = "string",
        },
        Service = new Konnect.Inputs.GatewayPluginKafkaConsumeServiceArgs
        {
            Id = "string",
        },
        Tags = new[]
        {
            "string",
        },
        UpdatedAt = 0,
    });
    
    example, err := konnect.NewGatewayPluginKafkaConsume(ctx, "gatewayPluginKafkaConsumeResource", &konnect.GatewayPluginKafkaConsumeArgs{
    	ControlPlaneId: pulumi.String("string"),
    	Config: &konnect.GatewayPluginKafkaConsumeConfigArgs{
    		BootstrapServers: konnect.GatewayPluginKafkaConsumeConfigBootstrapServerArray{
    			&konnect.GatewayPluginKafkaConsumeConfigBootstrapServerArgs{
    				Host: pulumi.String("string"),
    				Port: pulumi.Float64(0),
    			},
    		},
    		Topics: konnect.GatewayPluginKafkaConsumeConfigTopicArray{
    			&konnect.GatewayPluginKafkaConsumeConfigTopicArgs{
    				Name: pulumi.String("string"),
    				SchemaRegistry: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs{
    					Confluent: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs{
    						Authentication: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs{
    							Basic: &konnect.GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs{
    								Password: pulumi.String("string"),
    								Username: pulumi.String("string"),
    							},
    							Mode: pulumi.String("string"),
    						},
    						SslVerify: pulumi.Bool(false),
    						Ttl:       pulumi.Float64(0),
    						Url:       pulumi.String("string"),
    					},
    				},
    			},
    		},
    		Authentication: &konnect.GatewayPluginKafkaConsumeConfigAuthenticationArgs{
    			Mechanism: pulumi.String("string"),
    			Password:  pulumi.String("string"),
    			Strategy:  pulumi.String("string"),
    			Tokenauth: pulumi.Bool(false),
    			User:      pulumi.String("string"),
    		},
    		AutoOffsetReset:     pulumi.String("string"),
    		ClusterName:         pulumi.String("string"),
    		CommitStrategy:      pulumi.String("string"),
    		MessageDeserializer: pulumi.String("string"),
    		Mode:                pulumi.String("string"),
    		SchemaRegistry: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryArgs{
    			Confluent: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentArgs{
    				Authentication: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationArgs{
    					Basic: &konnect.GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasicArgs{
    						Password: pulumi.String("string"),
    						Username: pulumi.String("string"),
    					},
    					Mode: pulumi.String("string"),
    				},
    				SslVerify: pulumi.Bool(false),
    				Ttl:       pulumi.Float64(0),
    				Url:       pulumi.String("string"),
    			},
    		},
    		Security: &konnect.GatewayPluginKafkaConsumeConfigSecurityArgs{
    			CertificateId: pulumi.String("string"),
    			Ssl:           pulumi.Bool(false),
    		},
    	},
    	InstanceName:                pulumi.String("string"),
    	CreatedAt:                   pulumi.Float64(0),
    	Enabled:                     pulumi.Bool(false),
    	GatewayPluginKafkaConsumeId: pulumi.String("string"),
    	Consumer: &konnect.GatewayPluginKafkaConsumeConsumerArgs{
    		Id: pulumi.String("string"),
    	},
    	Ordering: &konnect.GatewayPluginKafkaConsumeOrderingArgs{
    		After: &konnect.GatewayPluginKafkaConsumeOrderingAfterArgs{
    			Accesses: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    		Before: &konnect.GatewayPluginKafkaConsumeOrderingBeforeArgs{
    			Accesses: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Partials: konnect.GatewayPluginKafkaConsumePartialArray{
    		&konnect.GatewayPluginKafkaConsumePartialArgs{
    			Id:   pulumi.String("string"),
    			Name: pulumi.String("string"),
    			Path: pulumi.String("string"),
    		},
    	},
    	Protocols: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Route: &konnect.GatewayPluginKafkaConsumeRouteArgs{
    		Id: pulumi.String("string"),
    	},
    	Service: &konnect.GatewayPluginKafkaConsumeServiceArgs{
    		Id: pulumi.String("string"),
    	},
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UpdatedAt: pulumi.Float64(0),
    })
    
    var gatewayPluginKafkaConsumeResource = new GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource", GatewayPluginKafkaConsumeArgs.builder()
        .controlPlaneId("string")
        .config(GatewayPluginKafkaConsumeConfigArgs.builder()
            .bootstrapServers(GatewayPluginKafkaConsumeConfigBootstrapServerArgs.builder()
                .host("string")
                .port(0.0)
                .build())
            .topics(GatewayPluginKafkaConsumeConfigTopicArgs.builder()
                .name("string")
                .schemaRegistry(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs.builder()
                    .confluent(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs.builder()
                        .authentication(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs.builder()
                            .basic(GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs.builder()
                                .password("string")
                                .username("string")
                                .build())
                            .mode("string")
                            .build())
                        .sslVerify(false)
                        .ttl(0.0)
                        .url("string")
                        .build())
                    .build())
                .build())
            .authentication(GatewayPluginKafkaConsumeConfigAuthenticationArgs.builder()
                .mechanism("string")
                .password("string")
                .strategy("string")
                .tokenauth(false)
                .user("string")
                .build())
            .autoOffsetReset("string")
            .clusterName("string")
            .commitStrategy("string")
            .messageDeserializer("string")
            .mode("string")
            .schemaRegistry(GatewayPluginKafkaConsumeConfigSchemaRegistryArgs.builder()
                .confluent(GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentArgs.builder()
                    .authentication(GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationArgs.builder()
                        .basic(GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasicArgs.builder()
                            .password("string")
                            .username("string")
                            .build())
                        .mode("string")
                        .build())
                    .sslVerify(false)
                    .ttl(0.0)
                    .url("string")
                    .build())
                .build())
            .security(GatewayPluginKafkaConsumeConfigSecurityArgs.builder()
                .certificateId("string")
                .ssl(false)
                .build())
            .build())
        .instanceName("string")
        .createdAt(0.0)
        .enabled(false)
        .gatewayPluginKafkaConsumeId("string")
        .consumer(GatewayPluginKafkaConsumeConsumerArgs.builder()
            .id("string")
            .build())
        .ordering(GatewayPluginKafkaConsumeOrderingArgs.builder()
            .after(GatewayPluginKafkaConsumeOrderingAfterArgs.builder()
                .accesses("string")
                .build())
            .before(GatewayPluginKafkaConsumeOrderingBeforeArgs.builder()
                .accesses("string")
                .build())
            .build())
        .partials(GatewayPluginKafkaConsumePartialArgs.builder()
            .id("string")
            .name("string")
            .path("string")
            .build())
        .protocols("string")
        .route(GatewayPluginKafkaConsumeRouteArgs.builder()
            .id("string")
            .build())
        .service(GatewayPluginKafkaConsumeServiceArgs.builder()
            .id("string")
            .build())
        .tags("string")
        .updatedAt(0.0)
        .build());
    
    gateway_plugin_kafka_consume_resource = konnect.GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource",
        control_plane_id="string",
        config={
            "bootstrap_servers": [{
                "host": "string",
                "port": 0,
            }],
            "topics": [{
                "name": "string",
                "schema_registry": {
                    "confluent": {
                        "authentication": {
                            "basic": {
                                "password": "string",
                                "username": "string",
                            },
                            "mode": "string",
                        },
                        "ssl_verify": False,
                        "ttl": 0,
                        "url": "string",
                    },
                },
            }],
            "authentication": {
                "mechanism": "string",
                "password": "string",
                "strategy": "string",
                "tokenauth": False,
                "user": "string",
            },
            "auto_offset_reset": "string",
            "cluster_name": "string",
            "commit_strategy": "string",
            "message_deserializer": "string",
            "mode": "string",
            "schema_registry": {
                "confluent": {
                    "authentication": {
                        "basic": {
                            "password": "string",
                            "username": "string",
                        },
                        "mode": "string",
                    },
                    "ssl_verify": False,
                    "ttl": 0,
                    "url": "string",
                },
            },
            "security": {
                "certificate_id": "string",
                "ssl": False,
            },
        },
        instance_name="string",
        created_at=0,
        enabled=False,
        gateway_plugin_kafka_consume_id="string",
        consumer={
            "id": "string",
        },
        ordering={
            "after": {
                "accesses": ["string"],
            },
            "before": {
                "accesses": ["string"],
            },
        },
        partials=[{
            "id": "string",
            "name": "string",
            "path": "string",
        }],
        protocols=["string"],
        route={
            "id": "string",
        },
        service={
            "id": "string",
        },
        tags=["string"],
        updated_at=0)
    
    const gatewayPluginKafkaConsumeResource = new konnect.GatewayPluginKafkaConsume("gatewayPluginKafkaConsumeResource", {
        controlPlaneId: "string",
        config: {
            bootstrapServers: [{
                host: "string",
                port: 0,
            }],
            topics: [{
                name: "string",
                schemaRegistry: {
                    confluent: {
                        authentication: {
                            basic: {
                                password: "string",
                                username: "string",
                            },
                            mode: "string",
                        },
                        sslVerify: false,
                        ttl: 0,
                        url: "string",
                    },
                },
            }],
            authentication: {
                mechanism: "string",
                password: "string",
                strategy: "string",
                tokenauth: false,
                user: "string",
            },
            autoOffsetReset: "string",
            clusterName: "string",
            commitStrategy: "string",
            messageDeserializer: "string",
            mode: "string",
            schemaRegistry: {
                confluent: {
                    authentication: {
                        basic: {
                            password: "string",
                            username: "string",
                        },
                        mode: "string",
                    },
                    sslVerify: false,
                    ttl: 0,
                    url: "string",
                },
            },
            security: {
                certificateId: "string",
                ssl: false,
            },
        },
        instanceName: "string",
        createdAt: 0,
        enabled: false,
        gatewayPluginKafkaConsumeId: "string",
        consumer: {
            id: "string",
        },
        ordering: {
            after: {
                accesses: ["string"],
            },
            before: {
                accesses: ["string"],
            },
        },
        partials: [{
            id: "string",
            name: "string",
            path: "string",
        }],
        protocols: ["string"],
        route: {
            id: "string",
        },
        service: {
            id: "string",
        },
        tags: ["string"],
        updatedAt: 0,
    });
    
    type: konnect:GatewayPluginKafkaConsume
    properties:
        config:
            authentication:
                mechanism: string
                password: string
                strategy: string
                tokenauth: false
                user: string
            autoOffsetReset: string
            bootstrapServers:
                - host: string
                  port: 0
            clusterName: string
            commitStrategy: string
            messageDeserializer: string
            mode: string
            schemaRegistry:
                confluent:
                    authentication:
                        basic:
                            password: string
                            username: string
                        mode: string
                    sslVerify: false
                    ttl: 0
                    url: string
            security:
                certificateId: string
                ssl: false
            topics:
                - name: string
                  schemaRegistry:
                    confluent:
                        authentication:
                            basic:
                                password: string
                                username: string
                            mode: string
                        sslVerify: false
                        ttl: 0
                        url: string
        consumer:
            id: string
        controlPlaneId: string
        createdAt: 0
        enabled: false
        gatewayPluginKafkaConsumeId: string
        instanceName: string
        ordering:
            after:
                accesses:
                    - string
            before:
                accesses:
                    - string
        partials:
            - id: string
              name: string
              path: string
        protocols:
            - string
        route:
            id: string
        service:
            id: string
        tags:
            - string
        updatedAt: 0
    

    GatewayPluginKafkaConsume 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 GatewayPluginKafkaConsume resource accepts the following input properties:

    Config GatewayPluginKafkaConsumeConfig
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginKafkaConsumeConsumer
    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. Default: true
    GatewayPluginKafkaConsumeId string
    A string representing a UUID (universally unique identifier).
    InstanceName string
    A unique string representing a UTF-8 encoded name.
    Ordering GatewayPluginKafkaConsumeOrdering
    Partials List<GatewayPluginKafkaConsumePartial>
    A list of partials to be used by the plugin.
    Protocols List<string>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    Route GatewayPluginKafkaConsumeRoute
    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 GatewayPluginKafkaConsumeService
    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 GatewayPluginKafkaConsumeConfigArgs
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Consumer GatewayPluginKafkaConsumeConsumerArgs
    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. Default: true
    GatewayPluginKafkaConsumeId string
    A string representing a UUID (universally unique identifier).
    InstanceName string
    A unique string representing a UTF-8 encoded name.
    Ordering GatewayPluginKafkaConsumeOrderingArgs
    Partials []GatewayPluginKafkaConsumePartialArgs
    A list of partials to be used by the plugin.
    Protocols []string
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    Route GatewayPluginKafkaConsumeRouteArgs
    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 GatewayPluginKafkaConsumeServiceArgs
    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 GatewayPluginKafkaConsumeConfig
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginKafkaConsumeConsumer
    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. Default: true
    gatewayPluginKafkaConsumeId String
    A string representing a UUID (universally unique identifier).
    instanceName String
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginKafkaConsumeOrdering
    partials List<GatewayPluginKafkaConsumePartial>
    A list of partials to be used by the plugin.
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginKafkaConsumeRoute
    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 GatewayPluginKafkaConsumeService
    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 GatewayPluginKafkaConsumeConfig
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginKafkaConsumeConsumer
    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. Default: true
    gatewayPluginKafkaConsumeId string
    A string representing a UUID (universally unique identifier).
    instanceName string
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginKafkaConsumeOrdering
    partials GatewayPluginKafkaConsumePartial[]
    A list of partials to be used by the plugin.
    protocols string[]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginKafkaConsumeRoute
    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 GatewayPluginKafkaConsumeService
    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 GatewayPluginKafkaConsumeConfigArgs
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    consumer GatewayPluginKafkaConsumeConsumerArgs
    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. Default: true
    gateway_plugin_kafka_consume_id str
    A string representing a UUID (universally unique identifier).
    instance_name str
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginKafkaConsumeOrderingArgs
    partials Sequence[GatewayPluginKafkaConsumePartialArgs]
    A list of partials to be used by the plugin.
    protocols Sequence[str]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginKafkaConsumeRouteArgs
    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 GatewayPluginKafkaConsumeServiceArgs
    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
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    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. Default: true
    gatewayPluginKafkaConsumeId String
    A string representing a UUID (universally unique identifier).
    instanceName String
    A unique string representing a UTF-8 encoded name.
    ordering Property Map
    partials List<Property Map>
    A list of partials to be used by the plugin.
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    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 GatewayPluginKafkaConsume 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 GatewayPluginKafkaConsume Resource

    Get an existing GatewayPluginKafkaConsume 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?: GatewayPluginKafkaConsumeState, opts?: CustomResourceOptions): GatewayPluginKafkaConsume
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            config: Optional[GatewayPluginKafkaConsumeConfigArgs] = None,
            consumer: Optional[GatewayPluginKafkaConsumeConsumerArgs] = None,
            control_plane_id: Optional[str] = None,
            created_at: Optional[float] = None,
            enabled: Optional[bool] = None,
            gateway_plugin_kafka_consume_id: Optional[str] = None,
            instance_name: Optional[str] = None,
            ordering: Optional[GatewayPluginKafkaConsumeOrderingArgs] = None,
            partials: Optional[Sequence[GatewayPluginKafkaConsumePartialArgs]] = None,
            protocols: Optional[Sequence[str]] = None,
            route: Optional[GatewayPluginKafkaConsumeRouteArgs] = None,
            service: Optional[GatewayPluginKafkaConsumeServiceArgs] = None,
            tags: Optional[Sequence[str]] = None,
            updated_at: Optional[float] = None) -> GatewayPluginKafkaConsume
    func GetGatewayPluginKafkaConsume(ctx *Context, name string, id IDInput, state *GatewayPluginKafkaConsumeState, opts ...ResourceOption) (*GatewayPluginKafkaConsume, error)
    public static GatewayPluginKafkaConsume Get(string name, Input<string> id, GatewayPluginKafkaConsumeState? state, CustomResourceOptions? opts = null)
    public static GatewayPluginKafkaConsume get(String name, Output<String> id, GatewayPluginKafkaConsumeState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayPluginKafkaConsume    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 GatewayPluginKafkaConsumeConfig
    Consumer GatewayPluginKafkaConsumeConsumer
    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. Default: true
    GatewayPluginKafkaConsumeId string
    A string representing a UUID (universally unique identifier).
    InstanceName string
    A unique string representing a UTF-8 encoded name.
    Ordering GatewayPluginKafkaConsumeOrdering
    Partials List<GatewayPluginKafkaConsumePartial>
    A list of partials to be used by the plugin.
    Protocols List<string>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    Route GatewayPluginKafkaConsumeRoute
    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 GatewayPluginKafkaConsumeService
    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 GatewayPluginKafkaConsumeConfigArgs
    Consumer GatewayPluginKafkaConsumeConsumerArgs
    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. Default: true
    GatewayPluginKafkaConsumeId string
    A string representing a UUID (universally unique identifier).
    InstanceName string
    A unique string representing a UTF-8 encoded name.
    Ordering GatewayPluginKafkaConsumeOrderingArgs
    Partials []GatewayPluginKafkaConsumePartialArgs
    A list of partials to be used by the plugin.
    Protocols []string
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    Route GatewayPluginKafkaConsumeRouteArgs
    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 GatewayPluginKafkaConsumeServiceArgs
    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 GatewayPluginKafkaConsumeConfig
    consumer GatewayPluginKafkaConsumeConsumer
    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. Default: true
    gatewayPluginKafkaConsumeId String
    A string representing a UUID (universally unique identifier).
    instanceName String
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginKafkaConsumeOrdering
    partials List<GatewayPluginKafkaConsumePartial>
    A list of partials to be used by the plugin.
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginKafkaConsumeRoute
    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 GatewayPluginKafkaConsumeService
    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 GatewayPluginKafkaConsumeConfig
    consumer GatewayPluginKafkaConsumeConsumer
    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. Default: true
    gatewayPluginKafkaConsumeId string
    A string representing a UUID (universally unique identifier).
    instanceName string
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginKafkaConsumeOrdering
    partials GatewayPluginKafkaConsumePartial[]
    A list of partials to be used by the plugin.
    protocols string[]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginKafkaConsumeRoute
    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 GatewayPluginKafkaConsumeService
    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 GatewayPluginKafkaConsumeConfigArgs
    consumer GatewayPluginKafkaConsumeConsumerArgs
    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. Default: true
    gateway_plugin_kafka_consume_id str
    A string representing a UUID (universally unique identifier).
    instance_name str
    A unique string representing a UTF-8 encoded name.
    ordering GatewayPluginKafkaConsumeOrderingArgs
    partials Sequence[GatewayPluginKafkaConsumePartialArgs]
    A list of partials to be used by the plugin.
    protocols Sequence[str]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    route GatewayPluginKafkaConsumeRouteArgs
    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 GatewayPluginKafkaConsumeServiceArgs
    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. Default: true
    gatewayPluginKafkaConsumeId String
    A string representing a UUID (universally unique identifier).
    instanceName String
    A unique string representing a UTF-8 encoded name.
    ordering Property Map
    partials List<Property Map>
    A list of partials to be used by the plugin.
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
    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

    GatewayPluginKafkaConsumeConfig, GatewayPluginKafkaConsumeConfigArgs

    BootstrapServers List<GatewayPluginKafkaConsumeConfigBootstrapServer>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    Topics List<GatewayPluginKafkaConsumeConfigTopic>
    The Kafka topics and their configuration you want to consume from.
    Authentication GatewayPluginKafkaConsumeConfigAuthentication
    AutoOffsetReset string
    The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
    ClusterName string
    An identifier for the Kafka cluster.
    CommitStrategy string
    The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
    MessageDeserializer string
    The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
    Mode string
    The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
    SchemaRegistry GatewayPluginKafkaConsumeConfigSchemaRegistry
    The plugin-global schema registry configuration.
    Security GatewayPluginKafkaConsumeConfigSecurity
    BootstrapServers []GatewayPluginKafkaConsumeConfigBootstrapServer
    Set of bootstrap brokers in a {host: host, port: port} list format.
    Topics []GatewayPluginKafkaConsumeConfigTopic
    The Kafka topics and their configuration you want to consume from.
    Authentication GatewayPluginKafkaConsumeConfigAuthentication
    AutoOffsetReset string
    The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
    ClusterName string
    An identifier for the Kafka cluster.
    CommitStrategy string
    The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
    MessageDeserializer string
    The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
    Mode string
    The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
    SchemaRegistry GatewayPluginKafkaConsumeConfigSchemaRegistry
    The plugin-global schema registry configuration.
    Security GatewayPluginKafkaConsumeConfigSecurity
    bootstrapServers List<GatewayPluginKafkaConsumeConfigBootstrapServer>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    topics List<GatewayPluginKafkaConsumeConfigTopic>
    The Kafka topics and their configuration you want to consume from.
    authentication GatewayPluginKafkaConsumeConfigAuthentication
    autoOffsetReset String
    The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
    clusterName String
    An identifier for the Kafka cluster.
    commitStrategy String
    The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
    messageDeserializer String
    The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
    mode String
    The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
    schemaRegistry GatewayPluginKafkaConsumeConfigSchemaRegistry
    The plugin-global schema registry configuration.
    security GatewayPluginKafkaConsumeConfigSecurity
    bootstrapServers GatewayPluginKafkaConsumeConfigBootstrapServer[]
    Set of bootstrap brokers in a {host: host, port: port} list format.
    topics GatewayPluginKafkaConsumeConfigTopic[]
    The Kafka topics and their configuration you want to consume from.
    authentication GatewayPluginKafkaConsumeConfigAuthentication
    autoOffsetReset string
    The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
    clusterName string
    An identifier for the Kafka cluster.
    commitStrategy string
    The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
    messageDeserializer string
    The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
    mode string
    The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
    schemaRegistry GatewayPluginKafkaConsumeConfigSchemaRegistry
    The plugin-global schema registry configuration.
    security GatewayPluginKafkaConsumeConfigSecurity
    bootstrap_servers Sequence[GatewayPluginKafkaConsumeConfigBootstrapServer]
    Set of bootstrap brokers in a {host: host, port: port} list format.
    topics Sequence[GatewayPluginKafkaConsumeConfigTopic]
    The Kafka topics and their configuration you want to consume from.
    authentication GatewayPluginKafkaConsumeConfigAuthentication
    auto_offset_reset str
    The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
    cluster_name str
    An identifier for the Kafka cluster.
    commit_strategy str
    The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
    message_deserializer str
    The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
    mode str
    The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
    schema_registry GatewayPluginKafkaConsumeConfigSchemaRegistry
    The plugin-global schema registry configuration.
    security GatewayPluginKafkaConsumeConfigSecurity
    bootstrapServers List<Property Map>
    Set of bootstrap brokers in a {host: host, port: port} list format.
    topics List<Property Map>
    The Kafka topics and their configuration you want to consume from.
    authentication Property Map
    autoOffsetReset String
    The offset to start from when there is no initial offset in the consumer group. Default: "latest"; must be one of ["earliest", "latest"]
    clusterName String
    An identifier for the Kafka cluster.
    commitStrategy String
    The strategy to use for committing offsets. Default: "auto"; must be one of ["auto", "off"]
    messageDeserializer String
    The deserializer to use for the consumed messages. Default: "noop"; must be one of ["json", "noop"]
    mode String
    The mode of operation for the plugin. Default: "http-get"; must be one of ["http-get", "server-sent-events", "websocket"]
    schemaRegistry Property Map
    The plugin-global schema registry configuration.
    security Property Map

    GatewayPluginKafkaConsumeConfigAuthentication, GatewayPluginKafkaConsumeConfigAuthenticationArgs

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

    GatewayPluginKafkaConsumeConfigBootstrapServer, GatewayPluginKafkaConsumeConfigBootstrapServerArgs

    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

    GatewayPluginKafkaConsumeConfigSchemaRegistry, GatewayPluginKafkaConsumeConfigSchemaRegistryArgs

    GatewayPluginKafkaConsumeConfigSchemaRegistryConfluent, GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentArgs

    Authentication GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthentication
    SslVerify bool
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    Ttl double
    The TTL in seconds for the schema registry cache.
    Url string
    The URL of the schema registry.
    Authentication GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthentication
    SslVerify bool
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    Ttl float64
    The TTL in seconds for the schema registry cache.
    Url string
    The URL of the schema registry.
    authentication GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthentication
    sslVerify Boolean
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    ttl Double
    The TTL in seconds for the schema registry cache.
    url String
    The URL of the schema registry.
    authentication GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthentication
    sslVerify boolean
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    ttl number
    The TTL in seconds for the schema registry cache.
    url string
    The URL of the schema registry.
    authentication GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthentication
    ssl_verify bool
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    ttl float
    The TTL in seconds for the schema registry cache.
    url str
    The URL of the schema registry.
    authentication Property Map
    sslVerify Boolean
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    ttl Number
    The TTL in seconds for the schema registry cache.
    url String
    The URL of the schema registry.

    GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthentication, GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationArgs

    Basic GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasic
    Mode string
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    Basic GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasic
    Mode string
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    basic GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasic
    mode String
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    basic GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasic
    mode string
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    basic GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasic
    mode str
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    basic Property Map
    mode String
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]

    GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasic, GatewayPluginKafkaConsumeConfigSchemaRegistryConfluentAuthenticationBasicArgs

    Password string
    Username string
    Password string
    Username string
    password String
    username String
    password string
    username string
    password String
    username String

    GatewayPluginKafkaConsumeConfigSecurity, GatewayPluginKafkaConsumeConfigSecurityArgs

    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.

    GatewayPluginKafkaConsumeConfigTopic, GatewayPluginKafkaConsumeConfigTopicArgs

    Name string
    Not Null
    SchemaRegistry GatewayPluginKafkaConsumeConfigTopicSchemaRegistry
    The plugin-global schema registry configuration. Not Null
    Name string
    Not Null
    SchemaRegistry GatewayPluginKafkaConsumeConfigTopicSchemaRegistry
    The plugin-global schema registry configuration. Not Null
    name String
    Not Null
    schemaRegistry GatewayPluginKafkaConsumeConfigTopicSchemaRegistry
    The plugin-global schema registry configuration. Not Null
    name string
    Not Null
    schemaRegistry GatewayPluginKafkaConsumeConfigTopicSchemaRegistry
    The plugin-global schema registry configuration. Not Null
    name str
    Not Null
    schema_registry GatewayPluginKafkaConsumeConfigTopicSchemaRegistry
    The plugin-global schema registry configuration. Not Null
    name String
    Not Null
    schemaRegistry Property Map
    The plugin-global schema registry configuration. Not Null

    GatewayPluginKafkaConsumeConfigTopicSchemaRegistry, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryArgs

    GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluent, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentArgs

    Authentication GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthentication
    Not Null
    SslVerify bool
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    Ttl double
    The TTL in seconds for the schema registry cache.
    Url string
    The URL of the schema registry.
    Authentication GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthentication
    Not Null
    SslVerify bool
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    Ttl float64
    The TTL in seconds for the schema registry cache.
    Url string
    The URL of the schema registry.
    authentication GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthentication
    Not Null
    sslVerify Boolean
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    ttl Double
    The TTL in seconds for the schema registry cache.
    url String
    The URL of the schema registry.
    authentication GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthentication
    Not Null
    sslVerify boolean
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    ttl number
    The TTL in seconds for the schema registry cache.
    url string
    The URL of the schema registry.
    authentication GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthentication
    Not Null
    ssl_verify bool
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    ttl float
    The TTL in seconds for the schema registry cache.
    url str
    The URL of the schema registry.
    authentication Property Map
    Not Null
    sslVerify Boolean
    Set to false to disable SSL certificate verification when connecting to the schema registry. Default: true
    ttl Number
    The TTL in seconds for the schema registry cache.
    url String
    The URL of the schema registry.

    GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthentication, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationArgs

    Basic GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasic
    Mode string
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    Basic GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasic
    Mode string
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    basic GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasic
    mode String
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    basic GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasic
    mode string
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    basic GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasic
    mode str
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]
    basic Property Map
    mode String
    Authentication mode to use with the schema registry. Default: "none"; must be one of ["basic", "none"]

    GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasic, GatewayPluginKafkaConsumeConfigTopicSchemaRegistryConfluentAuthenticationBasicArgs

    Password string
    Not Null
    Username string
    Not Null
    Password string
    Not Null
    Username string
    Not Null
    password String
    Not Null
    username String
    Not Null
    password string
    Not Null
    username string
    Not Null
    password str
    Not Null
    username str
    Not Null
    password String
    Not Null
    username String
    Not Null

    GatewayPluginKafkaConsumeConsumer, GatewayPluginKafkaConsumeConsumerArgs

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

    GatewayPluginKafkaConsumeOrdering, GatewayPluginKafkaConsumeOrderingArgs

    GatewayPluginKafkaConsumeOrderingAfter, GatewayPluginKafkaConsumeOrderingAfterArgs

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

    GatewayPluginKafkaConsumeOrderingBefore, GatewayPluginKafkaConsumeOrderingBeforeArgs

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

    GatewayPluginKafkaConsumePartial, GatewayPluginKafkaConsumePartialArgs

    Id string
    A string representing a UUID (universally unique identifier).
    Name string
    A unique string representing a UTF-8 encoded name.
    Path string
    Id string
    A string representing a UUID (universally unique identifier).
    Name string
    A unique string representing a UTF-8 encoded name.
    Path string
    id String
    A string representing a UUID (universally unique identifier).
    name String
    A unique string representing a UTF-8 encoded name.
    path String
    id string
    A string representing a UUID (universally unique identifier).
    name string
    A unique string representing a UTF-8 encoded name.
    path string
    id str
    A string representing a UUID (universally unique identifier).
    name str
    A unique string representing a UTF-8 encoded name.
    path str
    id String
    A string representing a UUID (universally unique identifier).
    name String
    A unique string representing a UTF-8 encoded name.
    path String

    GatewayPluginKafkaConsumeRoute, GatewayPluginKafkaConsumeRouteArgs

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

    GatewayPluginKafkaConsumeService, GatewayPluginKafkaConsumeServiceArgs

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

    Import

    $ pulumi import konnect:index/gatewayPluginKafkaConsume:GatewayPluginKafkaConsume my_konnect_gateway_plugin_kafka_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 logo
    konnect 3.0.0 published on Friday, Aug 22, 2025 by kong