1. Packages
  2. Konnect Provider
  3. API Docs
  4. EventGatewayListener
Viewing docs for konnect 3.11.0
published on Thursday, Mar 12, 2026 by kong
konnect logo
Viewing docs for konnect 3.11.0
published on Thursday, Mar 12, 2026 by kong

    EventGatewayListener Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as konnect from "@pulumi/konnect";
    
    const myEventgatewaylistener = new konnect.EventGatewayListener("my_eventgatewaylistener", {
        addresses: ["..."],
        description: "...my_description...",
        gatewayId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        labels: {
            key: "value",
        },
        name: "...my_name...",
        ports: ["..."],
    });
    
    import pulumi
    import pulumi_konnect as konnect
    
    my_eventgatewaylistener = konnect.EventGatewayListener("my_eventgatewaylistener",
        addresses=["..."],
        description="...my_description...",
        gateway_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
        labels={
            "key": "value",
        },
        name="...my_name...",
        ports=["..."])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/konnect"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := konnect.NewEventGatewayListener(ctx, "my_eventgatewaylistener", &konnect.EventGatewayListenerArgs{
    			Addresses: pulumi.StringArray{
    				pulumi.String("..."),
    			},
    			Description: pulumi.String("...my_description..."),
    			GatewayId:   pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
    			Labels: pulumi.StringMap{
    				"key": pulumi.String("value"),
    			},
    			Name: pulumi.String("...my_name..."),
    			Ports: pulumi.StringArray{
    				pulumi.String("..."),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Konnect = Pulumi.Konnect;
    
    return await Deployment.RunAsync(() => 
    {
        var myEventgatewaylistener = new Konnect.EventGatewayListener("my_eventgatewaylistener", new()
        {
            Addresses = new[]
            {
                "...",
            },
            Description = "...my_description...",
            GatewayId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
            Labels = 
            {
                { "key", "value" },
            },
            Name = "...my_name...",
            Ports = new[]
            {
                "...",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.EventGatewayListener;
    import com.pulumi.konnect.EventGatewayListenerArgs;
    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 myEventgatewaylistener = new EventGatewayListener("myEventgatewaylistener", EventGatewayListenerArgs.builder()
                .addresses("...")
                .description("...my_description...")
                .gatewayId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
                .labels(Map.of("key", "value"))
                .name("...my_name...")
                .ports("...")
                .build());
    
        }
    }
    
    resources:
      myEventgatewaylistener:
        type: konnect:EventGatewayListener
        name: my_eventgatewaylistener
        properties:
          addresses:
            - '...'
          description: '...my_description...'
          gatewayId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
          labels:
            key: value
          name: '...my_name...'
          ports:
            - '...'
    

    Create EventGatewayListener Resource

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

    Constructor syntax

    new EventGatewayListener(name: string, args: EventGatewayListenerArgs, opts?: CustomResourceOptions);
    @overload
    def EventGatewayListener(resource_name: str,
                             args: EventGatewayListenerArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def EventGatewayListener(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             addresses: Optional[Sequence[str]] = None,
                             gateway_id: Optional[str] = None,
                             ports: Optional[Sequence[str]] = None,
                             description: Optional[str] = None,
                             labels: Optional[Mapping[str, str]] = None,
                             name: Optional[str] = None)
    func NewEventGatewayListener(ctx *Context, name string, args EventGatewayListenerArgs, opts ...ResourceOption) (*EventGatewayListener, error)
    public EventGatewayListener(string name, EventGatewayListenerArgs args, CustomResourceOptions? opts = null)
    public EventGatewayListener(String name, EventGatewayListenerArgs args)
    public EventGatewayListener(String name, EventGatewayListenerArgs args, CustomResourceOptions options)
    
    type: konnect:EventGatewayListener
    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 EventGatewayListenerArgs
    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 EventGatewayListenerArgs
    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 EventGatewayListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventGatewayListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventGatewayListenerArgs
    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 eventGatewayListenerResource = new Konnect.EventGatewayListener("eventGatewayListenerResource", new()
    {
        Addresses = new[]
        {
            "string",
        },
        GatewayId = "string",
        Ports = new[]
        {
            "string",
        },
        Description = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Name = "string",
    });
    
    example, err := konnect.NewEventGatewayListener(ctx, "eventGatewayListenerResource", &konnect.EventGatewayListenerArgs{
    	Addresses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	GatewayId: pulumi.String("string"),
    	Ports: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    })
    
    var eventGatewayListenerResource = new EventGatewayListener("eventGatewayListenerResource", EventGatewayListenerArgs.builder()
        .addresses("string")
        .gatewayId("string")
        .ports("string")
        .description("string")
        .labels(Map.of("string", "string"))
        .name("string")
        .build());
    
    event_gateway_listener_resource = konnect.EventGatewayListener("eventGatewayListenerResource",
        addresses=["string"],
        gateway_id="string",
        ports=["string"],
        description="string",
        labels={
            "string": "string",
        },
        name="string")
    
    const eventGatewayListenerResource = new konnect.EventGatewayListener("eventGatewayListenerResource", {
        addresses: ["string"],
        gatewayId: "string",
        ports: ["string"],
        description: "string",
        labels: {
            string: "string",
        },
        name: "string",
    });
    
    type: konnect:EventGatewayListener
    properties:
        addresses:
            - string
        description: string
        gatewayId: string
        labels:
            string: string
        name: string
        ports:
            - string
    

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

    Addresses List<string>
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    GatewayId string
    The UUID of your Gateway.
    Ports List<string>

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    Description string
    A human-readable description of the listener. Default: ""
    Labels Dictionary<string, string>

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    Name string
    The unique name of the listener.
    Addresses []string
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    GatewayId string
    The UUID of your Gateway.
    Ports []string

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    Description string
    A human-readable description of the listener. Default: ""
    Labels map[string]string

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    Name string
    The unique name of the listener.
    addresses List<String>
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    gatewayId String
    The UUID of your Gateway.
    ports List<String>

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    description String
    A human-readable description of the listener. Default: ""
    labels Map<String,String>

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    name String
    The unique name of the listener.
    addresses string[]
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    gatewayId string
    The UUID of your Gateway.
    ports string[]

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    description string
    A human-readable description of the listener. Default: ""
    labels {[key: string]: string}

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    name string
    The unique name of the listener.
    addresses Sequence[str]
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    gateway_id str
    The UUID of your Gateway.
    ports Sequence[str]

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    description str
    A human-readable description of the listener. Default: ""
    labels Mapping[str, str]

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    name str
    The unique name of the listener.
    addresses List<String>
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    gatewayId String
    The UUID of your Gateway.
    ports List<String>

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    description String
    A human-readable description of the listener. Default: ""
    labels Map<String>

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    name String
    The unique name of the listener.

    Outputs

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

    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Look up Existing EventGatewayListener Resource

    Get an existing EventGatewayListener 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?: EventGatewayListenerState, opts?: CustomResourceOptions): EventGatewayListener
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            addresses: Optional[Sequence[str]] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            gateway_id: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            ports: Optional[Sequence[str]] = None,
            updated_at: Optional[str] = None) -> EventGatewayListener
    func GetEventGatewayListener(ctx *Context, name string, id IDInput, state *EventGatewayListenerState, opts ...ResourceOption) (*EventGatewayListener, error)
    public static EventGatewayListener Get(string name, Input<string> id, EventGatewayListenerState? state, CustomResourceOptions? opts = null)
    public static EventGatewayListener get(String name, Output<String> id, EventGatewayListenerState state, CustomResourceOptions options)
    resources:  _:    type: konnect:EventGatewayListener    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:
    Addresses List<string>
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    A human-readable description of the listener. Default: ""
    GatewayId string
    The UUID of your Gateway.
    Labels Dictionary<string, string>

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    Name string
    The unique name of the listener.
    Ports List<string>

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Addresses []string
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    A human-readable description of the listener. Default: ""
    GatewayId string
    The UUID of your Gateway.
    Labels map[string]string

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    Name string
    The unique name of the listener.
    Ports []string

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    addresses List<String>
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    A human-readable description of the listener. Default: ""
    gatewayId String
    The UUID of your Gateway.
    labels Map<String,String>

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    name String
    The unique name of the listener.
    ports List<String>

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    addresses string[]
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    description string
    A human-readable description of the listener. Default: ""
    gatewayId string
    The UUID of your Gateway.
    labels {[key: string]: string}

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    name string
    The unique name of the listener.
    ports string[]

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    addresses Sequence[str]
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    description str
    A human-readable description of the listener. Default: ""
    gateway_id str
    The UUID of your Gateway.
    labels Mapping[str, str]

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    name str
    The unique name of the listener.
    ports Sequence[str]

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    addresses List<String>
    Which address or addresses to listen on. 0.0.0.0 means all addresses on the host. :: means all addresses on the host in IPv6.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    A human-readable description of the listener. Default: ""
    gatewayId String
    The UUID of your Gateway.
    labels Map<String>

    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

    Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

    name String
    The unique name of the listener.
    ports List<String>

    Which port or ports to listen on. There can be multiple ways to define ports:

    • as a single port, e.g. 9092
    • as a range of ports, e.g. 9092-9094

    It's possible to combine both, e.g. [9092, "9093-9095", 9096].

    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = konnect_event_gateway_listener.my_konnect_event_gateway_listener

    id = jsonencode({

    gateway_id = "9524ec7d-36d9-465d-a8c5-83a3c9390458"
    
    id = "..."
    

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/eventGatewayListener:EventGatewayListener my_konnect_event_gateway_listener '{"gateway_id": "9524ec7d-36d9-465d-a8c5-83a3c9390458", "id": "..."}'
    

    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
    Viewing docs for konnect 3.11.0
    published on Thursday, Mar 12, 2026 by kong
      Try Pulumi Cloud free. Your team will thank you.