1. Packages
  2. Confluent Provider
  3. API Docs
  4. getKafkaClusters
Viewing docs for Confluent v2.59.0
published on Friday, Mar 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.getKafkaClusters

confluentcloud logo
Viewing docs for Confluent v2.59.0
published on Friday, Mar 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.getKafkaClusters describes a data source for Kafka Clusters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";

const main = confluentcloud.getKafkaClusters({
    environment: {
        id: "env-123abc",
    },
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.get_kafka_clusters(environment={
    "id": "env-123abc",
})

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := confluentcloud.GetKafkaClusters(ctx, &confluentcloud.GetKafkaClustersArgs{
			Environment: confluentcloud.GetKafkaClustersEnvironment{
				Id: "env-123abc",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var main = ConfluentCloud.GetKafkaClusters.Invoke(new()
    {
        Environment = new ConfluentCloud.Inputs.GetKafkaClustersEnvironmentInputArgs
        {
            Id = "env-123abc",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetKafkaClustersArgs;
import com.pulumi.confluentcloud.inputs.GetKafkaClustersEnvironmentArgs;
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) {
        final var main = ConfluentcloudFunctions.getKafkaClusters(GetKafkaClustersArgs.builder()
            .environment(GetKafkaClustersEnvironmentArgs.builder()
                .id("env-123abc")
                .build())
            .build());

    }
}

    variables:
  main:
    fn::invoke:
      function: confluentcloud:getKafkaClusters
      arguments:
        environment:
          id: env-123abc

    Using getKafkaClusters

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKafkaClusters(args: GetKafkaClustersArgs, opts?: InvokeOptions): Promise<GetKafkaClustersResult>
function getKafkaClustersOutput(args: GetKafkaClustersOutputArgs, opts?: InvokeOptions): Output<GetKafkaClustersResult>
    def get_kafka_clusters(environment: Optional[GetKafkaClustersEnvironment] = None,
                       opts: Optional[InvokeOptions] = None) -> GetKafkaClustersResult
def get_kafka_clusters_output(environment: Optional[pulumi.Input[GetKafkaClustersEnvironmentArgs]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetKafkaClustersResult]
    func GetKafkaClusters(ctx *Context, args *GetKafkaClustersArgs, opts ...InvokeOption) (*GetKafkaClustersResult, error)
func GetKafkaClustersOutput(ctx *Context, args *GetKafkaClustersOutputArgs, opts ...InvokeOption) GetKafkaClustersResultOutput

    > Note: This function is named GetKafkaClusters in the Go SDK.

    public static class GetKafkaClusters 
{
    public static Task<GetKafkaClustersResult> InvokeAsync(GetKafkaClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetKafkaClustersResult> Invoke(GetKafkaClustersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKafkaClustersResult> getKafkaClusters(GetKafkaClustersArgs args, InvokeOptions options)
public static Output<GetKafkaClustersResult> getKafkaClusters(GetKafkaClustersArgs args, InvokeOptions options)

    fn::invoke:
  function: confluentcloud:index/getKafkaClusters:getKafkaClusters
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Environment Pulumi.ConfluentCloud.Inputs.GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    Environment GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    environment GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    environment GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    environment GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    environment Property Map
    (Required Object) exports the following attributes:

    getKafkaClusters Result

    The following output properties are available:

    Clusters List<Pulumi.ConfluentCloud.Outputs.GetKafkaClustersCluster>
    (Required List of Object) List of Kafka clusters. Each Kafka cluster object exports the following attributes:
    Environment Pulumi.ConfluentCloud.Outputs.GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Clusters []GetKafkaClustersCluster
    (Required List of Object) List of Kafka clusters. Each Kafka cluster object exports the following attributes:
    Environment GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    clusters List<GetKafkaClustersCluster>
    (Required List of Object) List of Kafka clusters. Each Kafka cluster object exports the following attributes:
    environment GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    clusters GetKafkaClustersCluster[]
    (Required List of Object) List of Kafka clusters. Each Kafka cluster object exports the following attributes:
    environment GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    id string
    The provider-assigned unique ID for this managed resource.
    clusters Sequence[GetKafkaClustersCluster]
    (Required List of Object) List of Kafka clusters. Each Kafka cluster object exports the following attributes:
    environment GetKafkaClustersEnvironment
    (Required Object) exports the following attributes:
    id str
    The provider-assigned unique ID for this managed resource.
    clusters List<Property Map>
    (Required List of Object) List of Kafka clusters. Each Kafka cluster object exports the following attributes:
    environment Property Map
    (Required Object) exports the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetKafkaClustersCluster

    ApiVersion string
    (Required String) An API Version of the schema version of the Kafka cluster, for example, cmk/v2.
    Availability string
    (Required String) The availability zone configuration of the Kafka cluster. Accepted values are: SINGLE_ZONE, MULTI_ZONE, LOW, and HIGH.
    BootstrapEndpoint string
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    ByokKeys List<Pulumi.ConfluentCloud.Inputs.GetKafkaClustersClusterByokKey>
    (Optional Configuration Block) supports the following:
    Cloud string
    (Required String) The cloud service provider that runs the Kafka cluster. Accepted values are: AWS, AZURE, and GCP.
    DisplayName string
    (Required String) The name of the Kafka cluster.
    Endpoints List<Pulumi.ConfluentCloud.Inputs.GetKafkaClustersClusterEndpoint>
    (Optional List) The list of endpoints for connecting to the Kafka cluster. These endpoints provide different network access methods or regions for connecting to the cluster:
    Environment Pulumi.ConfluentCloud.Inputs.GetKafkaClustersClusterEnvironment
    (Required Object) exports the following attributes:
    Id string
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    Kind string
    (Required String) A kind of the Kafka cluster, for example, Cluster.
    Networks List<Pulumi.ConfluentCloud.Inputs.GetKafkaClustersClusterNetwork>
    (Optional Configuration Block) supports the following:
    RbacCrn string
    (Required String) The Confluent Resource Name of the Kafka cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123.
    Region string
    (Required String) The cloud service provider region where the Kafka cluster is running, for example, us-west-2. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.
    RestEndpoint string
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    Basics List<Pulumi.ConfluentCloud.Inputs.GetKafkaClustersClusterBasic>
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    Dedicated Pulumi.ConfluentCloud.Inputs.GetKafkaClustersClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    Enterprises List<Pulumi.ConfluentCloud.Inputs.GetKafkaClustersClusterEnterprise>
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    Freights List<Pulumi.ConfluentCloud.Inputs.GetKafkaClustersClusterFreight>
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    Standards List<Pulumi.ConfluentCloud.Inputs.GetKafkaClustersClusterStandard>
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    ApiVersion string
    (Required String) An API Version of the schema version of the Kafka cluster, for example, cmk/v2.
    Availability string
    (Required String) The availability zone configuration of the Kafka cluster. Accepted values are: SINGLE_ZONE, MULTI_ZONE, LOW, and HIGH.
    BootstrapEndpoint string
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    ByokKeys []GetKafkaClustersClusterByokKey
    (Optional Configuration Block) supports the following:
    Cloud string
    (Required String) The cloud service provider that runs the Kafka cluster. Accepted values are: AWS, AZURE, and GCP.
    DisplayName string
    (Required String) The name of the Kafka cluster.
    Endpoints []GetKafkaClustersClusterEndpoint
    (Optional List) The list of endpoints for connecting to the Kafka cluster. These endpoints provide different network access methods or regions for connecting to the cluster:
    Environment GetKafkaClustersClusterEnvironment
    (Required Object) exports the following attributes:
    Id string
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    Kind string
    (Required String) A kind of the Kafka cluster, for example, Cluster.
    Networks []GetKafkaClustersClusterNetwork
    (Optional Configuration Block) supports the following:
    RbacCrn string
    (Required String) The Confluent Resource Name of the Kafka cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123.
    Region string
    (Required String) The cloud service provider region where the Kafka cluster is running, for example, us-west-2. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.
    RestEndpoint string
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    Basics []GetKafkaClustersClusterBasic
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    Dedicated GetKafkaClustersClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    Enterprises []GetKafkaClustersClusterEnterprise
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    Freights []GetKafkaClustersClusterFreight
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    Standards []GetKafkaClustersClusterStandard
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    apiVersion String
    (Required String) An API Version of the schema version of the Kafka cluster, for example, cmk/v2.
    availability String
    (Required String) The availability zone configuration of the Kafka cluster. Accepted values are: SINGLE_ZONE, MULTI_ZONE, LOW, and HIGH.
    bootstrapEndpoint String
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    byokKeys List<GetKafkaClustersClusterByokKey>
    (Optional Configuration Block) supports the following:
    cloud String
    (Required String) The cloud service provider that runs the Kafka cluster. Accepted values are: AWS, AZURE, and GCP.
    displayName String
    (Required String) The name of the Kafka cluster.
    endpoints List<GetKafkaClustersClusterEndpoint>
    (Optional List) The list of endpoints for connecting to the Kafka cluster. These endpoints provide different network access methods or regions for connecting to the cluster:
    environment GetKafkaClustersClusterEnvironment
    (Required Object) exports the following attributes:
    id String
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    kind String
    (Required String) A kind of the Kafka cluster, for example, Cluster.
    networks List<GetKafkaClustersClusterNetwork>
    (Optional Configuration Block) supports the following:
    rbacCrn String
    (Required String) The Confluent Resource Name of the Kafka cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123.
    region String
    (Required String) The cloud service provider region where the Kafka cluster is running, for example, us-west-2. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.
    restEndpoint String
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    basics List<GetKafkaClustersClusterBasic>
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated GetKafkaClustersClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    enterprises List<GetKafkaClustersClusterEnterprise>
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights List<GetKafkaClustersClusterFreight>
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    standards List<GetKafkaClustersClusterStandard>
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    apiVersion string
    (Required String) An API Version of the schema version of the Kafka cluster, for example, cmk/v2.
    availability string
    (Required String) The availability zone configuration of the Kafka cluster. Accepted values are: SINGLE_ZONE, MULTI_ZONE, LOW, and HIGH.
    bootstrapEndpoint string
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    byokKeys GetKafkaClustersClusterByokKey[]
    (Optional Configuration Block) supports the following:
    cloud string
    (Required String) The cloud service provider that runs the Kafka cluster. Accepted values are: AWS, AZURE, and GCP.
    displayName string
    (Required String) The name of the Kafka cluster.
    endpoints GetKafkaClustersClusterEndpoint[]
    (Optional List) The list of endpoints for connecting to the Kafka cluster. These endpoints provide different network access methods or regions for connecting to the cluster:
    environment GetKafkaClustersClusterEnvironment
    (Required Object) exports the following attributes:
    id string
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    kind string
    (Required String) A kind of the Kafka cluster, for example, Cluster.
    networks GetKafkaClustersClusterNetwork[]
    (Optional Configuration Block) supports the following:
    rbacCrn string
    (Required String) The Confluent Resource Name of the Kafka cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123.
    region string
    (Required String) The cloud service provider region where the Kafka cluster is running, for example, us-west-2. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.
    restEndpoint string
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    basics GetKafkaClustersClusterBasic[]
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated GetKafkaClustersClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    enterprises GetKafkaClustersClusterEnterprise[]
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights GetKafkaClustersClusterFreight[]
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    standards GetKafkaClustersClusterStandard[]
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    api_version str
    (Required String) An API Version of the schema version of the Kafka cluster, for example, cmk/v2.
    availability str
    (Required String) The availability zone configuration of the Kafka cluster. Accepted values are: SINGLE_ZONE, MULTI_ZONE, LOW, and HIGH.
    bootstrap_endpoint str
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    byok_keys Sequence[GetKafkaClustersClusterByokKey]
    (Optional Configuration Block) supports the following:
    cloud str
    (Required String) The cloud service provider that runs the Kafka cluster. Accepted values are: AWS, AZURE, and GCP.
    display_name str
    (Required String) The name of the Kafka cluster.
    endpoints Sequence[GetKafkaClustersClusterEndpoint]
    (Optional List) The list of endpoints for connecting to the Kafka cluster. These endpoints provide different network access methods or regions for connecting to the cluster:
    environment GetKafkaClustersClusterEnvironment
    (Required Object) exports the following attributes:
    id str
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    kind str
    (Required String) A kind of the Kafka cluster, for example, Cluster.
    networks Sequence[GetKafkaClustersClusterNetwork]
    (Optional Configuration Block) supports the following:
    rbac_crn str
    (Required String) The Confluent Resource Name of the Kafka cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123.
    region str
    (Required String) The cloud service provider region where the Kafka cluster is running, for example, us-west-2. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.
    rest_endpoint str
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    basics Sequence[GetKafkaClustersClusterBasic]
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated GetKafkaClustersClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    enterprises Sequence[GetKafkaClustersClusterEnterprise]
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights Sequence[GetKafkaClustersClusterFreight]
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    standards Sequence[GetKafkaClustersClusterStandard]
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    apiVersion String
    (Required String) An API Version of the schema version of the Kafka cluster, for example, cmk/v2.
    availability String
    (Required String) The availability zone configuration of the Kafka cluster. Accepted values are: SINGLE_ZONE, MULTI_ZONE, LOW, and HIGH.
    bootstrapEndpoint String
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    byokKeys List<Property Map>
    (Optional Configuration Block) supports the following:
    cloud String
    (Required String) The cloud service provider that runs the Kafka cluster. Accepted values are: AWS, AZURE, and GCP.
    displayName String
    (Required String) The name of the Kafka cluster.
    endpoints List<Property Map>
    (Optional List) The list of endpoints for connecting to the Kafka cluster. These endpoints provide different network access methods or regions for connecting to the cluster:
    environment Property Map
    (Required Object) exports the following attributes:
    id String
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    kind String
    (Required String) A kind of the Kafka cluster, for example, Cluster.
    networks List<Property Map>
    (Optional Configuration Block) supports the following:
    rbacCrn String
    (Required String) The Confluent Resource Name of the Kafka cluster, for example, crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-abc123/cloud-cluster=lkc-abc123.
    region String
    (Required String) The cloud service provider region where the Kafka cluster is running, for example, us-west-2. See Cloud Providers and Regions for a full list of options for AWS, Azure, and GCP.
    restEndpoint String
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    basics List<Property Map>
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated Property Map
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    enterprises List<Property Map>
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights List<Property Map>
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    standards List<Property Map>
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.

    GetKafkaClustersClusterBasic

    MaxEcku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    MaxEcku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    maxEcku Integer
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    maxEcku number
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    max_ecku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    maxEcku Number
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.

    GetKafkaClustersClusterByokKey

    Id string
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    Id string
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    id String
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    id string
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    id str
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    id String
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.

    GetKafkaClustersClusterDedicated

    Cku int
    (Required Number) The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for SINGLE_ZONE dedicated clusters is 1 whereas MULTI_ZONE dedicated clusters must have 2 CKUs or more.
    EncryptionKey string
    The ID of the encryption key that is used to encrypt the data in the Kafka cluster.
    Zones List<string>
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    Cku int
    (Required Number) The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for SINGLE_ZONE dedicated clusters is 1 whereas MULTI_ZONE dedicated clusters must have 2 CKUs or more.
    EncryptionKey string
    The ID of the encryption key that is used to encrypt the data in the Kafka cluster.
    Zones []string
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    cku Integer
    (Required Number) The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for SINGLE_ZONE dedicated clusters is 1 whereas MULTI_ZONE dedicated clusters must have 2 CKUs or more.
    encryptionKey String
    The ID of the encryption key that is used to encrypt the data in the Kafka cluster.
    zones List<String>
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    cku number
    (Required Number) The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for SINGLE_ZONE dedicated clusters is 1 whereas MULTI_ZONE dedicated clusters must have 2 CKUs or more.
    encryptionKey string
    The ID of the encryption key that is used to encrypt the data in the Kafka cluster.
    zones string[]
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    cku int
    (Required Number) The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for SINGLE_ZONE dedicated clusters is 1 whereas MULTI_ZONE dedicated clusters must have 2 CKUs or more.
    encryption_key str
    The ID of the encryption key that is used to encrypt the data in the Kafka cluster.
    zones Sequence[str]
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    cku Number
    (Required Number) The number of Confluent Kafka Units (CKUs) for Dedicated cluster types. The minimum number of CKUs for SINGLE_ZONE dedicated clusters is 1 whereas MULTI_ZONE dedicated clusters must have 2 CKUs or more.
    encryptionKey String
    The ID of the encryption key that is used to encrypt the data in the Kafka cluster.
    zones List<String>
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.

    GetKafkaClustersClusterEndpoint

    AccessPointId string
    (Required String) The ID of the Access Point that the endpoint corresponds to. Access Point IDs PUBLIC and PRIVATE_LINK are reserved.
    BootstrapEndpoint string
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    ConnectionType string
    (Required String) The type of connection used for the endpoint (for example, PRIVATE_NETWORK_INTERFACE).
    RestEndpoint string
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    AccessPointId string
    (Required String) The ID of the Access Point that the endpoint corresponds to. Access Point IDs PUBLIC and PRIVATE_LINK are reserved.
    BootstrapEndpoint string
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    ConnectionType string
    (Required String) The type of connection used for the endpoint (for example, PRIVATE_NETWORK_INTERFACE).
    RestEndpoint string
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    accessPointId String
    (Required String) The ID of the Access Point that the endpoint corresponds to. Access Point IDs PUBLIC and PRIVATE_LINK are reserved.
    bootstrapEndpoint String
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    connectionType String
    (Required String) The type of connection used for the endpoint (for example, PRIVATE_NETWORK_INTERFACE).
    restEndpoint String
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    accessPointId string
    (Required String) The ID of the Access Point that the endpoint corresponds to. Access Point IDs PUBLIC and PRIVATE_LINK are reserved.
    bootstrapEndpoint string
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    connectionType string
    (Required String) The type of connection used for the endpoint (for example, PRIVATE_NETWORK_INTERFACE).
    restEndpoint string
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    access_point_id str
    (Required String) The ID of the Access Point that the endpoint corresponds to. Access Point IDs PUBLIC and PRIVATE_LINK are reserved.
    bootstrap_endpoint str
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    connection_type str
    (Required String) The type of connection used for the endpoint (for example, PRIVATE_NETWORK_INTERFACE).
    rest_endpoint str
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).
    accessPointId String
    (Required String) The ID of the Access Point that the endpoint corresponds to. Access Point IDs PUBLIC and PRIVATE_LINK are reserved.
    bootstrapEndpoint String
    (Required String) The bootstrap endpoint used by Kafka clients to connect to the cluster (for example, lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:9092).
    connectionType String
    (Required String) The type of connection used for the endpoint (for example, PRIVATE_NETWORK_INTERFACE).
    restEndpoint String
    (Required String) The REST endpoint of the Kafka cluster (for example, https://lkc-abc123-apfoo123.eu-west-3.aws.accesspoint.glb.confluent.cloud:443).

    GetKafkaClustersClusterEnterprise

    MaxEcku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    MaxEcku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    maxEcku Integer
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    maxEcku number
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    max_ecku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    maxEcku Number
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.

    GetKafkaClustersClusterEnvironment

    Id string
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    Id string
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    id String
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    id string
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    id str
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    id String
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.

    GetKafkaClustersClusterFreight

    MaxEcku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    Zones List<string>
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    MaxEcku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    Zones []string
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    maxEcku Integer
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    zones List<String>
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    maxEcku number
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    zones string[]
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    max_ecku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    zones Sequence[str]
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.
    maxEcku Number
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    zones List<String>
    (Required List of String) The list of zones the cluster is in.

    • On AWS, zones are AWS AZ IDs, for example, use1-az3.
    • On GCP, zones are GCP zones, for example, us-central1-c.
    • On Azure, zones are Confluent-chosen names (for example, 1, 2, 3) since Azure does not have universal zone identifiers.

    GetKafkaClustersClusterNetwork

    Id string
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    Id string
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    id String
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    id string
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    id str
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.
    id String
    (Required String) The ID of the Confluent key that is used to encrypt the data in the Kafka cluster, for example, cck-lye5m.

    GetKafkaClustersClusterStandard

    MaxEcku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    MaxEcku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    maxEcku Integer
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    maxEcku number
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    max_ecku int
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.
    maxEcku Number
    The maximum number of Elastic Confluent Kafka Units (eCKUs) that Kafka clusters should auto-scale to. Kafka clusters with HIGH availability must have at least two eCKUs.

    GetKafkaClustersEnvironment

    Id string
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    Id string
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    id String
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    id string
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    id str
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.
    id String
    The ID of the Environment that the Kafka clusters belongs to, for example, env-xyz456.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Viewing docs for Confluent v2.59.0
    published on Friday, Mar 6, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Try Pulumi Cloud free. Your team will thank you.