1. Packages
  2. Konnect Provider
  3. API Docs
  4. EventGatewayBackendCluster
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

    EventGatewayBackendCluster Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as konnect from "@pulumi/konnect";
    
    const myEventgatewaybackendcluster = new konnect.EventGatewayBackendCluster("my_eventgatewaybackendcluster", {
        authentication: {
            saslScram: {
                algorithm: "sha256",
                password: "${vault.env['MY_ENV_VAR']}",
                username: "...my_username...",
            },
        },
        bootstrapServers: ["..."],
        description: "...my_description...",
        gatewayId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        insecureAllowAnonymousVirtualClusterAuth: false,
        labels: {
            key: "value",
        },
        metadataUpdateIntervalSeconds: 22808,
        name: "...my_name...",
        tls: {
            caBundle: "...my_ca_bundle...",
            clientIdentity: {
                certificate: "...my_certificate...",
                key: "${vault.env['MY_ENV_VAR']}",
            },
            enabled: false,
            insecureSkipVerify: false,
            tlsVersions: ["tls12"],
        },
    });
    
    import pulumi
    import pulumi_konnect as konnect
    
    my_eventgatewaybackendcluster = konnect.EventGatewayBackendCluster("my_eventgatewaybackendcluster",
        authentication={
            "sasl_scram": {
                "algorithm": "sha256",
                "password": "${vault.env['MY_ENV_VAR']}",
                "username": "...my_username...",
            },
        },
        bootstrap_servers=["..."],
        description="...my_description...",
        gateway_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
        insecure_allow_anonymous_virtual_cluster_auth=False,
        labels={
            "key": "value",
        },
        metadata_update_interval_seconds=22808,
        name="...my_name...",
        tls={
            "ca_bundle": "...my_ca_bundle...",
            "client_identity": {
                "certificate": "...my_certificate...",
                "key": "${vault.env['MY_ENV_VAR']}",
            },
            "enabled": False,
            "insecure_skip_verify": False,
            "tls_versions": ["tls12"],
        })
    
    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.NewEventGatewayBackendCluster(ctx, "my_eventgatewaybackendcluster", &konnect.EventGatewayBackendClusterArgs{
    			Authentication: &konnect.EventGatewayBackendClusterAuthenticationArgs{
    				SaslScram: &konnect.EventGatewayBackendClusterAuthenticationSaslScramArgs{
    					Algorithm: pulumi.String("sha256"),
    					Password:  pulumi.String("${vault.env['MY_ENV_VAR']}"),
    					Username:  pulumi.String("...my_username..."),
    				},
    			},
    			BootstrapServers: pulumi.StringArray{
    				pulumi.String("..."),
    			},
    			Description:                              pulumi.String("...my_description..."),
    			GatewayId:                                pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
    			InsecureAllowAnonymousVirtualClusterAuth: pulumi.Bool(false),
    			Labels: pulumi.StringMap{
    				"key": pulumi.String("value"),
    			},
    			MetadataUpdateIntervalSeconds: pulumi.Float64(22808),
    			Name:                          pulumi.String("...my_name..."),
    			Tls: &konnect.EventGatewayBackendClusterTlsArgs{
    				CaBundle: pulumi.String("...my_ca_bundle..."),
    				ClientIdentity: &konnect.EventGatewayBackendClusterTlsClientIdentityArgs{
    					Certificate: pulumi.String("...my_certificate..."),
    					Key:         pulumi.String("${vault.env['MY_ENV_VAR']}"),
    				},
    				Enabled:            pulumi.Bool(false),
    				InsecureSkipVerify: pulumi.Bool(false),
    				TlsVersions: pulumi.StringArray{
    					pulumi.String("tls12"),
    				},
    			},
    		})
    		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 myEventgatewaybackendcluster = new Konnect.EventGatewayBackendCluster("my_eventgatewaybackendcluster", new()
        {
            Authentication = new Konnect.Inputs.EventGatewayBackendClusterAuthenticationArgs
            {
                SaslScram = new Konnect.Inputs.EventGatewayBackendClusterAuthenticationSaslScramArgs
                {
                    Algorithm = "sha256",
                    Password = "${vault.env['MY_ENV_VAR']}",
                    Username = "...my_username...",
                },
            },
            BootstrapServers = new[]
            {
                "...",
            },
            Description = "...my_description...",
            GatewayId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
            InsecureAllowAnonymousVirtualClusterAuth = false,
            Labels = 
            {
                { "key", "value" },
            },
            MetadataUpdateIntervalSeconds = 22808,
            Name = "...my_name...",
            Tls = new Konnect.Inputs.EventGatewayBackendClusterTlsArgs
            {
                CaBundle = "...my_ca_bundle...",
                ClientIdentity = new Konnect.Inputs.EventGatewayBackendClusterTlsClientIdentityArgs
                {
                    Certificate = "...my_certificate...",
                    Key = "${vault.env['MY_ENV_VAR']}",
                },
                Enabled = false,
                InsecureSkipVerify = false,
                TlsVersions = new[]
                {
                    "tls12",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.EventGatewayBackendCluster;
    import com.pulumi.konnect.EventGatewayBackendClusterArgs;
    import com.pulumi.konnect.inputs.EventGatewayBackendClusterAuthenticationArgs;
    import com.pulumi.konnect.inputs.EventGatewayBackendClusterAuthenticationSaslScramArgs;
    import com.pulumi.konnect.inputs.EventGatewayBackendClusterTlsArgs;
    import com.pulumi.konnect.inputs.EventGatewayBackendClusterTlsClientIdentityArgs;
    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 myEventgatewaybackendcluster = new EventGatewayBackendCluster("myEventgatewaybackendcluster", EventGatewayBackendClusterArgs.builder()
                .authentication(EventGatewayBackendClusterAuthenticationArgs.builder()
                    .saslScram(EventGatewayBackendClusterAuthenticationSaslScramArgs.builder()
                        .algorithm("sha256")
                        .password("${vault.env['MY_ENV_VAR']}")
                        .username("...my_username...")
                        .build())
                    .build())
                .bootstrapServers("...")
                .description("...my_description...")
                .gatewayId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
                .insecureAllowAnonymousVirtualClusterAuth(false)
                .labels(Map.of("key", "value"))
                .metadataUpdateIntervalSeconds(22808.0)
                .name("...my_name...")
                .tls(EventGatewayBackendClusterTlsArgs.builder()
                    .caBundle("...my_ca_bundle...")
                    .clientIdentity(EventGatewayBackendClusterTlsClientIdentityArgs.builder()
                        .certificate("...my_certificate...")
                        .key("${vault.env['MY_ENV_VAR']}")
                        .build())
                    .enabled(false)
                    .insecureSkipVerify(false)
                    .tlsVersions("tls12")
                    .build())
                .build());
    
        }
    }
    
    resources:
      myEventgatewaybackendcluster:
        type: konnect:EventGatewayBackendCluster
        name: my_eventgatewaybackendcluster
        properties:
          authentication:
            saslScram:
              algorithm: sha256
              password: $${vault.env['MY_ENV_VAR']}
              username: '...my_username...'
          bootstrapServers:
            - '...'
          description: '...my_description...'
          gatewayId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
          insecureAllowAnonymousVirtualClusterAuth: false
          labels:
            key: value
          metadataUpdateIntervalSeconds: 22808
          name: '...my_name...'
          tls:
            caBundle: '...my_ca_bundle...'
            clientIdentity:
              certificate: '...my_certificate...'
              key: $${vault.env['MY_ENV_VAR']}
            enabled: false
            insecureSkipVerify: false
            tlsVersions:
              - tls12
    

    Create EventGatewayBackendCluster Resource

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

    Constructor syntax

    new EventGatewayBackendCluster(name: string, args: EventGatewayBackendClusterArgs, opts?: CustomResourceOptions);
    @overload
    def EventGatewayBackendCluster(resource_name: str,
                                   args: EventGatewayBackendClusterArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def EventGatewayBackendCluster(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   authentication: Optional[EventGatewayBackendClusterAuthenticationArgs] = None,
                                   bootstrap_servers: Optional[Sequence[str]] = None,
                                   gateway_id: Optional[str] = None,
                                   tls: Optional[EventGatewayBackendClusterTlsArgs] = None,
                                   description: Optional[str] = None,
                                   insecure_allow_anonymous_virtual_cluster_auth: Optional[bool] = None,
                                   labels: Optional[Mapping[str, str]] = None,
                                   metadata_update_interval_seconds: Optional[float] = None,
                                   name: Optional[str] = None)
    func NewEventGatewayBackendCluster(ctx *Context, name string, args EventGatewayBackendClusterArgs, opts ...ResourceOption) (*EventGatewayBackendCluster, error)
    public EventGatewayBackendCluster(string name, EventGatewayBackendClusterArgs args, CustomResourceOptions? opts = null)
    public EventGatewayBackendCluster(String name, EventGatewayBackendClusterArgs args)
    public EventGatewayBackendCluster(String name, EventGatewayBackendClusterArgs args, CustomResourceOptions options)
    
    type: konnect:EventGatewayBackendCluster
    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 EventGatewayBackendClusterArgs
    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 EventGatewayBackendClusterArgs
    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 EventGatewayBackendClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventGatewayBackendClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventGatewayBackendClusterArgs
    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 eventGatewayBackendClusterResource = new Konnect.EventGatewayBackendCluster("eventGatewayBackendClusterResource", new()
    {
        Authentication = new Konnect.Inputs.EventGatewayBackendClusterAuthenticationArgs
        {
            Anonymous = null,
            SaslPlain = new Konnect.Inputs.EventGatewayBackendClusterAuthenticationSaslPlainArgs
            {
                Password = "string",
                Username = "string",
            },
            SaslScram = new Konnect.Inputs.EventGatewayBackendClusterAuthenticationSaslScramArgs
            {
                Algorithm = "string",
                Password = "string",
                Username = "string",
            },
        },
        BootstrapServers = new[]
        {
            "string",
        },
        GatewayId = "string",
        Tls = new Konnect.Inputs.EventGatewayBackendClusterTlsArgs
        {
            Enabled = false,
            CaBundle = "string",
            ClientIdentity = new Konnect.Inputs.EventGatewayBackendClusterTlsClientIdentityArgs
            {
                Certificate = "string",
                Key = "string",
            },
            InsecureSkipVerify = false,
            TlsVersions = new[]
            {
                "string",
            },
        },
        Description = "string",
        InsecureAllowAnonymousVirtualClusterAuth = false,
        Labels = 
        {
            { "string", "string" },
        },
        MetadataUpdateIntervalSeconds = 0,
        Name = "string",
    });
    
    example, err := konnect.NewEventGatewayBackendCluster(ctx, "eventGatewayBackendClusterResource", &konnect.EventGatewayBackendClusterArgs{
    	Authentication: &konnect.EventGatewayBackendClusterAuthenticationArgs{
    		Anonymous: &konnect.EventGatewayBackendClusterAuthenticationAnonymousArgs{},
    		SaslPlain: &konnect.EventGatewayBackendClusterAuthenticationSaslPlainArgs{
    			Password: pulumi.String("string"),
    			Username: pulumi.String("string"),
    		},
    		SaslScram: &konnect.EventGatewayBackendClusterAuthenticationSaslScramArgs{
    			Algorithm: pulumi.String("string"),
    			Password:  pulumi.String("string"),
    			Username:  pulumi.String("string"),
    		},
    	},
    	BootstrapServers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	GatewayId: pulumi.String("string"),
    	Tls: &konnect.EventGatewayBackendClusterTlsArgs{
    		Enabled:  pulumi.Bool(false),
    		CaBundle: pulumi.String("string"),
    		ClientIdentity: &konnect.EventGatewayBackendClusterTlsClientIdentityArgs{
    			Certificate: pulumi.String("string"),
    			Key:         pulumi.String("string"),
    		},
    		InsecureSkipVerify: pulumi.Bool(false),
    		TlsVersions: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Description:                              pulumi.String("string"),
    	InsecureAllowAnonymousVirtualClusterAuth: pulumi.Bool(false),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	MetadataUpdateIntervalSeconds: pulumi.Float64(0),
    	Name:                          pulumi.String("string"),
    })
    
    var eventGatewayBackendClusterResource = new EventGatewayBackendCluster("eventGatewayBackendClusterResource", EventGatewayBackendClusterArgs.builder()
        .authentication(EventGatewayBackendClusterAuthenticationArgs.builder()
            .anonymous(EventGatewayBackendClusterAuthenticationAnonymousArgs.builder()
                .build())
            .saslPlain(EventGatewayBackendClusterAuthenticationSaslPlainArgs.builder()
                .password("string")
                .username("string")
                .build())
            .saslScram(EventGatewayBackendClusterAuthenticationSaslScramArgs.builder()
                .algorithm("string")
                .password("string")
                .username("string")
                .build())
            .build())
        .bootstrapServers("string")
        .gatewayId("string")
        .tls(EventGatewayBackendClusterTlsArgs.builder()
            .enabled(false)
            .caBundle("string")
            .clientIdentity(EventGatewayBackendClusterTlsClientIdentityArgs.builder()
                .certificate("string")
                .key("string")
                .build())
            .insecureSkipVerify(false)
            .tlsVersions("string")
            .build())
        .description("string")
        .insecureAllowAnonymousVirtualClusterAuth(false)
        .labels(Map.of("string", "string"))
        .metadataUpdateIntervalSeconds(0.0)
        .name("string")
        .build());
    
    event_gateway_backend_cluster_resource = konnect.EventGatewayBackendCluster("eventGatewayBackendClusterResource",
        authentication={
            "anonymous": {},
            "sasl_plain": {
                "password": "string",
                "username": "string",
            },
            "sasl_scram": {
                "algorithm": "string",
                "password": "string",
                "username": "string",
            },
        },
        bootstrap_servers=["string"],
        gateway_id="string",
        tls={
            "enabled": False,
            "ca_bundle": "string",
            "client_identity": {
                "certificate": "string",
                "key": "string",
            },
            "insecure_skip_verify": False,
            "tls_versions": ["string"],
        },
        description="string",
        insecure_allow_anonymous_virtual_cluster_auth=False,
        labels={
            "string": "string",
        },
        metadata_update_interval_seconds=0,
        name="string")
    
    const eventGatewayBackendClusterResource = new konnect.EventGatewayBackendCluster("eventGatewayBackendClusterResource", {
        authentication: {
            anonymous: {},
            saslPlain: {
                password: "string",
                username: "string",
            },
            saslScram: {
                algorithm: "string",
                password: "string",
                username: "string",
            },
        },
        bootstrapServers: ["string"],
        gatewayId: "string",
        tls: {
            enabled: false,
            caBundle: "string",
            clientIdentity: {
                certificate: "string",
                key: "string",
            },
            insecureSkipVerify: false,
            tlsVersions: ["string"],
        },
        description: "string",
        insecureAllowAnonymousVirtualClusterAuth: false,
        labels: {
            string: "string",
        },
        metadataUpdateIntervalSeconds: 0,
        name: "string",
    });
    
    type: konnect:EventGatewayBackendCluster
    properties:
        authentication:
            anonymous: {}
            saslPlain:
                password: string
                username: string
            saslScram:
                algorithm: string
                password: string
                username: string
        bootstrapServers:
            - string
        description: string
        gatewayId: string
        insecureAllowAnonymousVirtualClusterAuth: false
        labels:
            string: string
        metadataUpdateIntervalSeconds: 0
        name: string
        tls:
            caBundle: string
            clientIdentity:
                certificate: string
                key: string
            enabled: false
            insecureSkipVerify: false
            tlsVersions:
                - string
    

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

    Authentication EventGatewayBackendClusterAuthentication
    BootstrapServers List<string>
    A list of cluster bootstrap servers in the format address:port.
    GatewayId string
    The UUID of your Gateway.
    Tls EventGatewayBackendClusterTls
    Description string
    A human-readable description of the backend cluster. Default: ""
    InsecureAllowAnonymousVirtualClusterAuth bool
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    MetadataUpdateIntervalSeconds double
    The interval at which metadata is updated in seconds. Default: 60
    Name string
    The unique name of the backend cluster.
    Authentication EventGatewayBackendClusterAuthenticationArgs
    BootstrapServers []string
    A list of cluster bootstrap servers in the format address:port.
    GatewayId string
    The UUID of your Gateway.
    Tls EventGatewayBackendClusterTlsArgs
    Description string
    A human-readable description of the backend cluster. Default: ""
    InsecureAllowAnonymousVirtualClusterAuth bool
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    MetadataUpdateIntervalSeconds float64
    The interval at which metadata is updated in seconds. Default: 60
    Name string
    The unique name of the backend cluster.
    authentication EventGatewayBackendClusterAuthentication
    bootstrapServers List<String>
    A list of cluster bootstrap servers in the format address:port.
    gatewayId String
    The UUID of your Gateway.
    tls EventGatewayBackendClusterTls
    description String
    A human-readable description of the backend cluster. Default: ""
    insecureAllowAnonymousVirtualClusterAuth Boolean
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    metadataUpdateIntervalSeconds Double
    The interval at which metadata is updated in seconds. Default: 60
    name String
    The unique name of the backend cluster.
    authentication EventGatewayBackendClusterAuthentication
    bootstrapServers string[]
    A list of cluster bootstrap servers in the format address:port.
    gatewayId string
    The UUID of your Gateway.
    tls EventGatewayBackendClusterTls
    description string
    A human-readable description of the backend cluster. Default: ""
    insecureAllowAnonymousVirtualClusterAuth boolean
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    metadataUpdateIntervalSeconds number
    The interval at which metadata is updated in seconds. Default: 60
    name string
    The unique name of the backend cluster.
    authentication EventGatewayBackendClusterAuthenticationArgs
    bootstrap_servers Sequence[str]
    A list of cluster bootstrap servers in the format address:port.
    gateway_id str
    The UUID of your Gateway.
    tls EventGatewayBackendClusterTlsArgs
    description str
    A human-readable description of the backend cluster. Default: ""
    insecure_allow_anonymous_virtual_cluster_auth bool
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    metadata_update_interval_seconds float
    The interval at which metadata is updated in seconds. Default: 60
    name str
    The unique name of the backend cluster.
    authentication Property Map
    bootstrapServers List<String>
    A list of cluster bootstrap servers in the format address:port.
    gatewayId String
    The UUID of your Gateway.
    tls Property Map
    description String
    A human-readable description of the backend cluster. Default: ""
    insecureAllowAnonymousVirtualClusterAuth Boolean
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    labels Map<String>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    metadataUpdateIntervalSeconds Number
    The interval at which metadata is updated in seconds. Default: 60
    name String
    The unique name of the backend cluster.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EventGatewayBackendCluster 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 EventGatewayBackendCluster Resource

    Get an existing EventGatewayBackendCluster 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?: EventGatewayBackendClusterState, opts?: CustomResourceOptions): EventGatewayBackendCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authentication: Optional[EventGatewayBackendClusterAuthenticationArgs] = None,
            bootstrap_servers: Optional[Sequence[str]] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            gateway_id: Optional[str] = None,
            insecure_allow_anonymous_virtual_cluster_auth: Optional[bool] = None,
            labels: Optional[Mapping[str, str]] = None,
            metadata_update_interval_seconds: Optional[float] = None,
            name: Optional[str] = None,
            tls: Optional[EventGatewayBackendClusterTlsArgs] = None,
            updated_at: Optional[str] = None) -> EventGatewayBackendCluster
    func GetEventGatewayBackendCluster(ctx *Context, name string, id IDInput, state *EventGatewayBackendClusterState, opts ...ResourceOption) (*EventGatewayBackendCluster, error)
    public static EventGatewayBackendCluster Get(string name, Input<string> id, EventGatewayBackendClusterState? state, CustomResourceOptions? opts = null)
    public static EventGatewayBackendCluster get(String name, Output<String> id, EventGatewayBackendClusterState state, CustomResourceOptions options)
    resources:  _:    type: konnect:EventGatewayBackendCluster    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:
    Authentication EventGatewayBackendClusterAuthentication
    BootstrapServers List<string>
    A list of cluster bootstrap servers in the format address:port.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    A human-readable description of the backend cluster. Default: ""
    GatewayId string
    The UUID of your Gateway.
    InsecureAllowAnonymousVirtualClusterAuth bool
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    MetadataUpdateIntervalSeconds double
    The interval at which metadata is updated in seconds. Default: 60
    Name string
    The unique name of the backend cluster.
    Tls EventGatewayBackendClusterTls
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Authentication EventGatewayBackendClusterAuthenticationArgs
    BootstrapServers []string
    A list of cluster bootstrap servers in the format address:port.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    A human-readable description of the backend cluster. Default: ""
    GatewayId string
    The UUID of your Gateway.
    InsecureAllowAnonymousVirtualClusterAuth bool
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    MetadataUpdateIntervalSeconds float64
    The interval at which metadata is updated in seconds. Default: 60
    Name string
    The unique name of the backend cluster.
    Tls EventGatewayBackendClusterTlsArgs
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    authentication EventGatewayBackendClusterAuthentication
    bootstrapServers List<String>
    A list of cluster bootstrap servers in the format address:port.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    A human-readable description of the backend cluster. Default: ""
    gatewayId String
    The UUID of your Gateway.
    insecureAllowAnonymousVirtualClusterAuth Boolean
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    metadataUpdateIntervalSeconds Double
    The interval at which metadata is updated in seconds. Default: 60
    name String
    The unique name of the backend cluster.
    tls EventGatewayBackendClusterTls
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    authentication EventGatewayBackendClusterAuthentication
    bootstrapServers string[]
    A list of cluster bootstrap servers in the format address:port.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    description string
    A human-readable description of the backend cluster. Default: ""
    gatewayId string
    The UUID of your Gateway.
    insecureAllowAnonymousVirtualClusterAuth boolean
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    metadataUpdateIntervalSeconds number
    The interval at which metadata is updated in seconds. Default: 60
    name string
    The unique name of the backend cluster.
    tls EventGatewayBackendClusterTls
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    authentication EventGatewayBackendClusterAuthenticationArgs
    bootstrap_servers Sequence[str]
    A list of cluster bootstrap servers in the format address:port.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    description str
    A human-readable description of the backend cluster. Default: ""
    gateway_id str
    The UUID of your Gateway.
    insecure_allow_anonymous_virtual_cluster_auth bool
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    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.
    metadata_update_interval_seconds float
    The interval at which metadata is updated in seconds. Default: 60
    name str
    The unique name of the backend cluster.
    tls EventGatewayBackendClusterTlsArgs
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    authentication Property Map
    bootstrapServers List<String>
    A list of cluster bootstrap servers in the format address:port.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    A human-readable description of the backend cluster. Default: ""
    gatewayId String
    The UUID of your Gateway.
    insecureAllowAnonymousVirtualClusterAuth Boolean
    If true, virtual clusters can have allow anonymous authentication and use this backend cluster. This setting is not recommended for production use as it may create privilege escalation vulnerabilities. Default: false
    labels Map<String>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    metadataUpdateIntervalSeconds Number
    The interval at which metadata is updated in seconds. Default: 60
    name String
    The unique name of the backend cluster.
    tls Property Map
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Supporting Types

    EventGatewayBackendClusterAuthentication, EventGatewayBackendClusterAuthenticationArgs

    Anonymous EventGatewayBackendClusterAuthenticationAnonymous
    Anonymous authentication scheme for the backend cluster.
    SaslPlain EventGatewayBackendClusterAuthenticationSaslPlain
    SASL/PLAIN authentication scheme for the backend cluster without requiring sensitive password data.
    SaslScram EventGatewayBackendClusterAuthenticationSaslScram
    SASL/SCRAM authentication scheme for the backend cluster without requiring sensitive password data.
    Anonymous EventGatewayBackendClusterAuthenticationAnonymous
    Anonymous authentication scheme for the backend cluster.
    SaslPlain EventGatewayBackendClusterAuthenticationSaslPlain
    SASL/PLAIN authentication scheme for the backend cluster without requiring sensitive password data.
    SaslScram EventGatewayBackendClusterAuthenticationSaslScram
    SASL/SCRAM authentication scheme for the backend cluster without requiring sensitive password data.
    anonymous EventGatewayBackendClusterAuthenticationAnonymous
    Anonymous authentication scheme for the backend cluster.
    saslPlain EventGatewayBackendClusterAuthenticationSaslPlain
    SASL/PLAIN authentication scheme for the backend cluster without requiring sensitive password data.
    saslScram EventGatewayBackendClusterAuthenticationSaslScram
    SASL/SCRAM authentication scheme for the backend cluster without requiring sensitive password data.
    anonymous EventGatewayBackendClusterAuthenticationAnonymous
    Anonymous authentication scheme for the backend cluster.
    saslPlain EventGatewayBackendClusterAuthenticationSaslPlain
    SASL/PLAIN authentication scheme for the backend cluster without requiring sensitive password data.
    saslScram EventGatewayBackendClusterAuthenticationSaslScram
    SASL/SCRAM authentication scheme for the backend cluster without requiring sensitive password data.
    anonymous EventGatewayBackendClusterAuthenticationAnonymous
    Anonymous authentication scheme for the backend cluster.
    sasl_plain EventGatewayBackendClusterAuthenticationSaslPlain
    SASL/PLAIN authentication scheme for the backend cluster without requiring sensitive password data.
    sasl_scram EventGatewayBackendClusterAuthenticationSaslScram
    SASL/SCRAM authentication scheme for the backend cluster without requiring sensitive password data.
    anonymous Property Map
    Anonymous authentication scheme for the backend cluster.
    saslPlain Property Map
    SASL/PLAIN authentication scheme for the backend cluster without requiring sensitive password data.
    saslScram Property Map
    SASL/SCRAM authentication scheme for the backend cluster without requiring sensitive password data.

    EventGatewayBackendClusterAuthenticationSaslPlain, EventGatewayBackendClusterAuthenticationSaslPlainArgs

    Password string
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    Username string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    Password string
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    Username string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    password String
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    username String
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    password string
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    username string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    password str
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    username str
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    password String
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    username String
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null

    EventGatewayBackendClusterAuthenticationSaslScram, EventGatewayBackendClusterAuthenticationSaslScramArgs

    Algorithm string
    The algorithm used for SASL/SCRAM authentication. Not Null; must be one of ["sha256", "sha512"]
    Password string
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    Username string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    Algorithm string
    The algorithm used for SASL/SCRAM authentication. Not Null; must be one of ["sha256", "sha512"]
    Password string
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    Username string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    algorithm String
    The algorithm used for SASL/SCRAM authentication. Not Null; must be one of ["sha256", "sha512"]
    password String
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    username String
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    algorithm string
    The algorithm used for SASL/SCRAM authentication. Not Null; must be one of ["sha256", "sha512"]
    password string
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    username string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    algorithm str
    The algorithm used for SASL/SCRAM authentication. Not Null; must be one of ["sha256", "sha512"]
    password str
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    username str
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null
    algorithm String
    The algorithm used for SASL/SCRAM authentication. Not Null; must be one of ["sha256", "sha512"]
    password String
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API. Not Null
    username String
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information. Not Null

    EventGatewayBackendClusterTls, EventGatewayBackendClusterTlsArgs

    Enabled bool
    If true, TLS is enabled for connections to this backend cluster. If false, TLS is explicitly disabled.
    CaBundle string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    ClientIdentity EventGatewayBackendClusterTlsClientIdentity
    Client mTLS configuration.
    InsecureSkipVerify bool
    If true, skip certificate verification. It's not secure to use for production. Default: false
    TlsVersions List<string>
    List of supported TLS versions. Default: ["tls12","tls13"]
    Enabled bool
    If true, TLS is enabled for connections to this backend cluster. If false, TLS is explicitly disabled.
    CaBundle string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    ClientIdentity EventGatewayBackendClusterTlsClientIdentity
    Client mTLS configuration.
    InsecureSkipVerify bool
    If true, skip certificate verification. It's not secure to use for production. Default: false
    TlsVersions []string
    List of supported TLS versions. Default: ["tls12","tls13"]
    enabled Boolean
    If true, TLS is enabled for connections to this backend cluster. If false, TLS is explicitly disabled.
    caBundle String
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    clientIdentity EventGatewayBackendClusterTlsClientIdentity
    Client mTLS configuration.
    insecureSkipVerify Boolean
    If true, skip certificate verification. It's not secure to use for production. Default: false
    tlsVersions List<String>
    List of supported TLS versions. Default: ["tls12","tls13"]
    enabled boolean
    If true, TLS is enabled for connections to this backend cluster. If false, TLS is explicitly disabled.
    caBundle string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    clientIdentity EventGatewayBackendClusterTlsClientIdentity
    Client mTLS configuration.
    insecureSkipVerify boolean
    If true, skip certificate verification. It's not secure to use for production. Default: false
    tlsVersions string[]
    List of supported TLS versions. Default: ["tls12","tls13"]
    enabled bool
    If true, TLS is enabled for connections to this backend cluster. If false, TLS is explicitly disabled.
    ca_bundle str
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    client_identity EventGatewayBackendClusterTlsClientIdentity
    Client mTLS configuration.
    insecure_skip_verify bool
    If true, skip certificate verification. It's not secure to use for production. Default: false
    tls_versions Sequence[str]
    List of supported TLS versions. Default: ["tls12","tls13"]
    enabled Boolean
    If true, TLS is enabled for connections to this backend cluster. If false, TLS is explicitly disabled.
    caBundle String
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    clientIdentity Property Map
    Client mTLS configuration.
    insecureSkipVerify Boolean
    If true, skip certificate verification. It's not secure to use for production. Default: false
    tlsVersions List<String>
    List of supported TLS versions. Default: ["tls12","tls13"]

    EventGatewayBackendClusterTlsClientIdentity, EventGatewayBackendClusterTlsClientIdentityArgs

    Certificate string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    Key string
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API.
    Certificate string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    Key string
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API.
    certificate String
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    key String
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API.
    certificate string
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    key string
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API.
    certificate str
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    key str
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API.
    certificate String
    A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensitive information.
    key String
    A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at rest and omitted from API responses. If provided as an expression, the expression itself is stored and returned by the API.

    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_backend_cluster.my_konnect_event_gateway_backend_cluster

    id = jsonencode({

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

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/eventGatewayBackendCluster:EventGatewayBackendCluster my_konnect_event_gateway_backend_cluster '{"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.