Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Cloud
  3. API Docs
  4. getKafkaCluster
Confluent v2.3.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getKafkaCluster

Explore with Pulumi AI

confluentcloud logo
Confluent v2.3.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.KafkaCluster describes a Kafka cluster data source.

    Example Usage

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

export = async () => {
    const exampleUsingId = await confluentcloud.getKafkaCluster({
        id: "lkc-abc123",
        environment: {
            id: "env-xyz456",
        },
    });
    const test_sa = new confluentcloud.ServiceAccount("test-sa", {
        displayName: "app_mgr",
        description: `app_mgr for ${exampleUsingId.displayName}`,
    });
    const exampleUsingName = await confluentcloud.getKafkaCluster({
        displayName: "basic_kafka_cluster",
        environment: {
            id: "env-xyz456",
        },
    });
    return {
        exampleUsingName: exampleUsingName,
    };
}

    import pulumi
import pulumi_confluentcloud as confluentcloud

example_using_id = confluentcloud.get_kafka_cluster(id="lkc-abc123",
    environment={
        "id": "env-xyz456",
    })
test_sa = confluentcloud.ServiceAccount("test-sa",
    display_name="app_mgr",
    description=f"app_mgr for {example_using_id.display_name}")
example_using_name = confluentcloud.get_kafka_cluster(display_name="basic_kafka_cluster",
    environment={
        "id": "env-xyz456",
    })
pulumi.export("exampleUsingName", example_using_name)

    package main

import (
	"fmt"

	"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 {
		exampleUsingId, err := confluentcloud.LookupKafkaCluster(ctx, &confluentcloud.LookupKafkaClusterArgs{
			Id: pulumi.StringRef("lkc-abc123"),
			Environment: confluentcloud.GetKafkaClusterEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewServiceAccount(ctx, "test-sa", &confluentcloud.ServiceAccountArgs{
			DisplayName: pulumi.String("app_mgr"),
			Description: pulumi.Sprintf("app_mgr for %v", exampleUsingId.DisplayName),
		})
		if err != nil {
			return err
		}
		exampleUsingName, err := confluentcloud.LookupKafkaCluster(ctx, &confluentcloud.LookupKafkaClusterArgs{
			DisplayName: pulumi.StringRef("basic_kafka_cluster"),
			Environment: confluentcloud.GetKafkaClusterEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingName", exampleUsingName)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleUsingId = ConfluentCloud.GetKafkaCluster.Invoke(new()
    {
        Id = "lkc-abc123",
        Environment = new ConfluentCloud.Inputs.GetKafkaClusterEnvironmentInputArgs
        {
            Id = "env-xyz456",
        },
    });

    var test_sa = new ConfluentCloud.ServiceAccount("test-sa", new()
    {
        DisplayName = "app_mgr",
        Description = $"app_mgr for {exampleUsingId.Apply(getKafkaClusterResult => getKafkaClusterResult.DisplayName)}",
    });

    var exampleUsingName = ConfluentCloud.GetKafkaCluster.Invoke(new()
    {
        DisplayName = "basic_kafka_cluster",
        Environment = new ConfluentCloud.Inputs.GetKafkaClusterEnvironmentInputArgs
        {
            Id = "env-xyz456",
        },
    });

    return new Dictionary<string, object?>
    {
        ["exampleUsingName"] = exampleUsingName,
    };
});

    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.GetKafkaClusterArgs;
import com.pulumi.confluentcloud.inputs.GetKafkaClusterEnvironmentArgs;
import com.pulumi.confluentcloud.ServiceAccount;
import com.pulumi.confluentcloud.ServiceAccountArgs;
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 exampleUsingId = ConfluentcloudFunctions.getKafkaCluster(GetKafkaClusterArgs.builder()
            .id("lkc-abc123")
            .environment(GetKafkaClusterEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        var test_sa = new ServiceAccount("test-sa", ServiceAccountArgs.builder()
            .displayName("app_mgr")
            .description(String.format("app_mgr for %s", exampleUsingId.applyValue(getKafkaClusterResult -> getKafkaClusterResult.displayName())))
            .build());

        final var exampleUsingName = ConfluentcloudFunctions.getKafkaCluster(GetKafkaClusterArgs.builder()
            .displayName("basic_kafka_cluster")
            .environment(GetKafkaClusterEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        ctx.export("exampleUsingName", exampleUsingName.applyValue(getKafkaClusterResult -> getKafkaClusterResult));
    }
}

    resources:
  test-sa:
    type: confluentcloud:ServiceAccount
    properties:
      displayName: app_mgr
      description: app_mgr for ${exampleUsingId.displayName}
variables:
  exampleUsingId:
    fn::invoke:
      Function: confluentcloud:getKafkaCluster
      Arguments:
        id: lkc-abc123
        environment:
          id: env-xyz456
  exampleUsingName:
    fn::invoke:
      Function: confluentcloud:getKafkaCluster
      Arguments:
        displayName: basic_kafka_cluster
        environment:
          id: env-xyz456
outputs:
  exampleUsingName: ${exampleUsingName}

    Using getKafkaCluster

    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 getKafkaCluster(args: GetKafkaClusterArgs, opts?: InvokeOptions): Promise<GetKafkaClusterResult>
function getKafkaClusterOutput(args: GetKafkaClusterOutputArgs, opts?: InvokeOptions): Output<GetKafkaClusterResult>
    def get_kafka_cluster(basics: Optional[Sequence[GetKafkaClusterBasic]] = None,
                      dedicated: Optional[GetKafkaClusterDedicated] = None,
                      display_name: Optional[str] = None,
                      enterprises: Optional[Sequence[GetKafkaClusterEnterprise]] = None,
                      environment: Optional[GetKafkaClusterEnvironment] = None,
                      freights: Optional[Sequence[GetKafkaClusterFreight]] = None,
                      id: Optional[str] = None,
                      standards: Optional[Sequence[GetKafkaClusterStandard]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetKafkaClusterResult
def get_kafka_cluster_output(basics: Optional[pulumi.Input[Sequence[pulumi.Input[GetKafkaClusterBasicArgs]]]] = None,
                      dedicated: Optional[pulumi.Input[GetKafkaClusterDedicatedArgs]] = None,
                      display_name: Optional[pulumi.Input[str]] = None,
                      enterprises: Optional[pulumi.Input[Sequence[pulumi.Input[GetKafkaClusterEnterpriseArgs]]]] = None,
                      environment: Optional[pulumi.Input[GetKafkaClusterEnvironmentArgs]] = None,
                      freights: Optional[pulumi.Input[Sequence[pulumi.Input[GetKafkaClusterFreightArgs]]]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      standards: Optional[pulumi.Input[Sequence[pulumi.Input[GetKafkaClusterStandardArgs]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetKafkaClusterResult]
    func LookupKafkaCluster(ctx *Context, args *LookupKafkaClusterArgs, opts ...InvokeOption) (*LookupKafkaClusterResult, error)
func LookupKafkaClusterOutput(ctx *Context, args *LookupKafkaClusterOutputArgs, opts ...InvokeOption) LookupKafkaClusterResultOutput

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

    public static class GetKafkaCluster 
{
    public static Task<GetKafkaClusterResult> InvokeAsync(GetKafkaClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetKafkaClusterResult> Invoke(GetKafkaClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKafkaClusterResult> getKafkaCluster(GetKafkaClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Environment Pulumi.ConfluentCloud.Inputs.GetKafkaClusterEnvironment
    Basics List<Pulumi.ConfluentCloud.Inputs.GetKafkaClusterBasic>
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    Dedicated Pulumi.ConfluentCloud.Inputs.GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    DisplayName string
    A human-readable name for the Kafka cluster.
    Enterprises List<Pulumi.ConfluentCloud.Inputs.GetKafkaClusterEnterprise>
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    Freights List<Pulumi.ConfluentCloud.Inputs.GetKafkaClusterFreight>
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    Id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    Standards List<Pulumi.ConfluentCloud.Inputs.GetKafkaClusterStandard>
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    Environment GetKafkaClusterEnvironment
    Basics []GetKafkaClusterBasic
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    Dedicated GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    DisplayName string
    A human-readable name for the Kafka cluster.
    Enterprises []GetKafkaClusterEnterprise
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    Freights []GetKafkaClusterFreight
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    Id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    Standards []GetKafkaClusterStandard
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    environment GetKafkaClusterEnvironment
    basics List<GetKafkaClusterBasic>
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    displayName String
    A human-readable name for the Kafka cluster.
    enterprises List<GetKafkaClusterEnterprise>
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights List<GetKafkaClusterFreight>
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    id String
    The ID of the Kafka cluster, for example, lkc-abc123.
    standards List<GetKafkaClusterStandard>
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    environment GetKafkaClusterEnvironment
    basics GetKafkaClusterBasic[]
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    displayName string
    A human-readable name for the Kafka cluster.
    enterprises GetKafkaClusterEnterprise[]
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights GetKafkaClusterFreight[]
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    standards GetKafkaClusterStandard[]
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    environment GetKafkaClusterEnvironment
    basics Sequence[GetKafkaClusterBasic]
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    display_name str
    A human-readable name for the Kafka cluster.
    enterprises Sequence[GetKafkaClusterEnterprise]
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights Sequence[GetKafkaClusterFreight]
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    id str
    The ID of the Kafka cluster, for example, lkc-abc123.
    standards Sequence[GetKafkaClusterStandard]
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.
    environment Property Map
    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:
    displayName String
    A human-readable name for the Kafka cluster.
    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.
    id String
    The ID of the Kafka cluster, for example, lkc-abc123.
    standards List<Property Map>
    (Optional Configuration Block) The configuration of the Standard Kafka cluster.

    getKafkaCluster Result

    The following output properties are available:

    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 Kafka cluster. (e.g., pkc-00000.us-central1.gcp.confluent.cloud:9092).
    ByokKeys List<Pulumi.ConfluentCloud.Outputs.GetKafkaClusterByokKey>
    (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.
    Environment Pulumi.ConfluentCloud.Outputs.GetKafkaClusterEnvironment
    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.Outputs.GetKafkaClusterNetwork>
    (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 (e.g., https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    Basics List<Pulumi.ConfluentCloud.Outputs.GetKafkaClusterBasic>
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    Dedicated Pulumi.ConfluentCloud.Outputs.GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    Enterprises List<Pulumi.ConfluentCloud.Outputs.GetKafkaClusterEnterprise>
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    Freights List<Pulumi.ConfluentCloud.Outputs.GetKafkaClusterFreight>
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    Standards List<Pulumi.ConfluentCloud.Outputs.GetKafkaClusterStandard>
    (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 Kafka cluster. (e.g., pkc-00000.us-central1.gcp.confluent.cloud:9092).
    ByokKeys []GetKafkaClusterByokKey
    (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.
    Environment GetKafkaClusterEnvironment
    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 []GetKafkaClusterNetwork
    (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 (e.g., https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    Basics []GetKafkaClusterBasic
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    Dedicated GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    Enterprises []GetKafkaClusterEnterprise
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    Freights []GetKafkaClusterFreight
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    Standards []GetKafkaClusterStandard
    (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 Kafka cluster. (e.g., pkc-00000.us-central1.gcp.confluent.cloud:9092).
    byokKeys List<GetKafkaClusterByokKey>
    (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.
    environment GetKafkaClusterEnvironment
    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<GetKafkaClusterNetwork>
    (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 (e.g., https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    basics List<GetKafkaClusterBasic>
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    enterprises List<GetKafkaClusterEnterprise>
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights List<GetKafkaClusterFreight>
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    standards List<GetKafkaClusterStandard>
    (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 Kafka cluster. (e.g., pkc-00000.us-central1.gcp.confluent.cloud:9092).
    byokKeys GetKafkaClusterByokKey[]
    (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.
    environment GetKafkaClusterEnvironment
    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 GetKafkaClusterNetwork[]
    (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 (e.g., https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    basics GetKafkaClusterBasic[]
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    enterprises GetKafkaClusterEnterprise[]
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights GetKafkaClusterFreight[]
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    standards GetKafkaClusterStandard[]
    (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 Kafka cluster. (e.g., pkc-00000.us-central1.gcp.confluent.cloud:9092).
    byok_keys Sequence[GetKafkaClusterByokKey]
    (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.
    environment GetKafkaClusterEnvironment
    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[GetKafkaClusterNetwork]
    (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 (e.g., https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    basics Sequence[GetKafkaClusterBasic]
    (Optional Configuration Block) The configuration of the Basic Kafka cluster.
    dedicated GetKafkaClusterDedicated
    (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
    enterprises Sequence[GetKafkaClusterEnterprise]
    (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
    freights Sequence[GetKafkaClusterFreight]
    (Optional Configuration Block) The configuration of the Freight Kafka cluster.
    standards Sequence[GetKafkaClusterStandard]
    (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 Kafka cluster. (e.g., pkc-00000.us-central1.gcp.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.
    environment Property Map
    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 (e.g., https://pkc-00000.us-central1.gcp.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.

    Supporting Types

    GetKafkaClusterByokKey

    Id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    Id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster, for example, lkc-abc123.
    id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    id str
    The ID of the Kafka cluster, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster, for example, lkc-abc123.

    GetKafkaClusterDedicated

    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.

    GetKafkaClusterEnvironment

    Id string

    The ID of the Environment that the Kafka cluster belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    Id string

    The ID of the Environment that the Kafka cluster belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String

    The ID of the Environment that the Kafka cluster belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id string

    The ID of the Environment that the Kafka cluster belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id str

    The ID of the Environment that the Kafka cluster belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String

    The ID of the Environment that the Kafka cluster belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    GetKafkaClusterFreight

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

    GetKafkaClusterNetwork

    Id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    Id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster, for example, lkc-abc123.
    id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    id str
    The ID of the Kafka cluster, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster, for example, lkc-abc123.

    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
    Confluent v2.3.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-confluentcloud