confluentcloud.getKafkaCluster
Explore with Pulumi AI
confluentcloud.KafkaCluster
describes a Kafka cluster data source.
Example Usage
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()
{
Description = $"app_mgr for {exampleUsingId.Apply(getKafkaClusterResult => getKafkaClusterResult.DisplayName)}",
});
var exampleUsingNameKafkaCluster = ConfluentCloud.GetKafkaCluster.Invoke(new()
{
DisplayName = "basic_kafka_cluster",
Environment = new ConfluentCloud.Inputs.GetKafkaClusterEnvironmentInputArgs
{
Id = "env-xyz456",
},
});
return new Dictionary<string, object?>
{
["exampleUsingName"] = exampleUsingNameKafkaCluster,
};
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-confluentcloud/sdk/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{
Description: pulumi.String(fmt.Sprintf("app_mgr for %v", exampleUsingId.DisplayName)),
})
if err != nil {
return err
}
exampleUsingNameKafkaCluster, 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", exampleUsingNameKafkaCluster)
return nil
})
}
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()
.description(String.format("app_mgr for %s", exampleUsingId.applyValue(getKafkaClusterResult -> getKafkaClusterResult.displayName())))
.build());
final var exampleUsingNameKafkaCluster = ConfluentcloudFunctions.getKafkaCluster(GetKafkaClusterArgs.builder()
.displayName("basic_kafka_cluster")
.environment(GetKafkaClusterEnvironmentArgs.builder()
.id("env-xyz456")
.build())
.build());
ctx.export("exampleUsingName", exampleUsingNameKafkaCluster.applyValue(getKafkaClusterResult -> getKafkaClusterResult));
}
}
import pulumi
import pulumi_confluentcloud as confluentcloud
example_using_id = confluentcloud.get_kafka_cluster(id="lkc-abc123",
environment=confluentcloud.GetKafkaClusterEnvironmentArgs(
id="env-xyz456",
))
test_sa = confluentcloud.ServiceAccount("test-sa", description=f"app_mgr for {example_using_id.display_name}")
example_using_name_kafka_cluster = confluentcloud.get_kafka_cluster(display_name="basic_kafka_cluster",
environment=confluentcloud.GetKafkaClusterEnvironmentArgs(
id="env-xyz456",
))
pulumi.export("exampleUsingName", example_using_name_kafka_cluster)
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const exampleUsingId = confluentcloud.getKafkaCluster({
id: "lkc-abc123",
environment: {
id: "env-xyz456",
},
});
const test_sa = new confluentcloud.ServiceAccount("test-sa", {description: exampleUsingId.then(exampleUsingId => `app_mgr for ${exampleUsingId.displayName}`)});
const exampleUsingNameKafkaCluster = confluentcloud.getKafkaCluster({
displayName: "basic_kafka_cluster",
environment: {
id: "env-xyz456",
},
});
export const exampleUsingName = exampleUsingNameKafkaCluster;
resources:
test-sa:
type: confluentcloud:ServiceAccount
properties:
description: app_mgr for ${exampleUsingId.displayName}
variables:
exampleUsingId:
fn::invoke:
Function: confluentcloud:getKafkaCluster
Arguments:
id: lkc-abc123
environment:
id: env-xyz456
exampleUsingNameKafkaCluster:
fn::invoke:
Function: confluentcloud:getKafkaCluster
Arguments:
displayName: basic_kafka_cluster
environment:
id: env-xyz456
outputs:
exampleUsingName: ${exampleUsingNameKafkaCluster}
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,
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,
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.
Confluent Cloud. Inputs. Get Kafka Cluster Environment - Basics
List<Pulumi.
Confluent Cloud. Inputs. Get Kafka Cluster Basic> (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- Dedicated
Pulumi.
Confluent Cloud. Inputs. Get Kafka Cluster Dedicated (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
- Display
Name string A human-readable name for the Kafka cluster.
- Enterprises
List<Pulumi.
Confluent Cloud. Inputs. Get Kafka Cluster Enterprise> (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- Id string
The ID of the Environment that the Kafka cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.- Standards
List<Pulumi.
Confluent Cloud. Inputs. Get Kafka Cluster Standard> (Optional Configuration Block) The configuration of the Standard Kafka cluster.
- Environment
Get
Kafka Cluster Environment - Basics
[]Get
Kafka Cluster Basic (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- Dedicated
Get
Kafka Cluster Dedicated (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
- Display
Name string A human-readable name for the Kafka cluster.
- Enterprises
[]Get
Kafka Cluster Enterprise (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- Id string
The ID of the Environment that the Kafka cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.- Standards
[]Get
Kafka Cluster Standard (Optional Configuration Block) The configuration of the Standard Kafka cluster.
- environment
Get
Kafka Cluster Environment - basics
List<Get
Kafka Cluster Basic> (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- dedicated
Get
Kafka Cluster Dedicated (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
- display
Name String A human-readable name for the Kafka cluster.
- enterprises
List<Get
Kafka Cluster Enterprise> (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- id String
The ID of the Environment that the Kafka cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.- standards
List<Get
Kafka Cluster Standard> (Optional Configuration Block) The configuration of the Standard Kafka cluster.
- environment
Get
Kafka Cluster Environment - basics
Get
Kafka Cluster Basic[] (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- dedicated
Get
Kafka Cluster Dedicated (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
- display
Name string A human-readable name for the Kafka cluster.
- enterprises
Get
Kafka Cluster Enterprise[] (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- id string
The ID of the Environment that the Kafka cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.- standards
Get
Kafka Cluster Standard[] (Optional Configuration Block) The configuration of the Standard Kafka cluster.
- environment
Get
Kafka Cluster Environment - basics
Sequence[Get
Kafka Cluster Basic] (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- dedicated
Get
Kafka Cluster Dedicated (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[Get
Kafka Cluster Enterprise] (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- id str
The ID of the Environment that the Kafka cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.- standards
Sequence[Get
Kafka Cluster Standard] (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:
- display
Name String A human-readable name for the Kafka cluster.
- enterprises List<Property Map>
(Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- id String
The ID of the Environment that the Kafka cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.- standards List<Property Map>
(Optional Configuration Block) The configuration of the Standard Kafka cluster.
getKafkaCluster Result
The following output properties are available:
- Api
Version 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
andMULTI_ZONE
.- Bootstrap
Endpoint 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
).- Byok
Keys List<Pulumi.Confluent Cloud. Outputs. Get Kafka Cluster Byok Key> (Optional Configuration Block) supports the following:
- Cloud string
(Required String) The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- Display
Name string (Required String) The name of the Kafka cluster.
- Environment
Pulumi.
Confluent Cloud. Outputs. Get Kafka Cluster Environment - 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.
Confluent Cloud. Outputs. Get Kafka Cluster Network> (Optional Configuration Block) supports the following:
- Rbac
Crn 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.- Rest
Endpoint string (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- Basics
List<Pulumi.
Confluent Cloud. Outputs. Get Kafka Cluster Basic> (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- Dedicated
Pulumi.
Confluent Cloud. Outputs. Get Kafka Cluster Dedicated (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
- Enterprises
List<Pulumi.
Confluent Cloud. Outputs. Get Kafka Cluster Enterprise> (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- Standards
List<Pulumi.
Confluent Cloud. Outputs. Get Kafka Cluster Standard> (Optional Configuration Block) The configuration of the Standard Kafka cluster.
- Api
Version 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
andMULTI_ZONE
.- Bootstrap
Endpoint 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
).- Byok
Keys []GetKafka Cluster Byok Key (Optional Configuration Block) supports the following:
- Cloud string
(Required String) The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- Display
Name string (Required String) The name of the Kafka cluster.
- Environment
Get
Kafka Cluster Environment - 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
[]Get
Kafka Cluster Network (Optional Configuration Block) supports the following:
- Rbac
Crn 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.- Rest
Endpoint string (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- Basics
[]Get
Kafka Cluster Basic (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- Dedicated
Get
Kafka Cluster Dedicated (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
- Enterprises
[]Get
Kafka Cluster Enterprise (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- Standards
[]Get
Kafka Cluster Standard (Optional Configuration Block) The configuration of the Standard Kafka cluster.
- api
Version 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
andMULTI_ZONE
.- bootstrap
Endpoint 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
).- byok
Keys List<GetKafka Cluster Byok Key> (Optional Configuration Block) supports the following:
- cloud String
(Required String) The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- display
Name String (Required String) The name of the Kafka cluster.
- environment
Get
Kafka Cluster Environment - 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<Get
Kafka Cluster Network> (Optional Configuration Block) supports the following:
- rbac
Crn 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.- rest
Endpoint String (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- basics
List<Get
Kafka Cluster Basic> (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- dedicated
Get
Kafka Cluster Dedicated (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
- enterprises
List<Get
Kafka Cluster Enterprise> (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- standards
List<Get
Kafka Cluster Standard> (Optional Configuration Block) The configuration of the Standard Kafka cluster.
- api
Version 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
andMULTI_ZONE
.- bootstrap
Endpoint 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
).- byok
Keys GetKafka Cluster Byok Key[] (Optional Configuration Block) supports the following:
- cloud string
(Required String) The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- display
Name string (Required String) The name of the Kafka cluster.
- environment
Get
Kafka Cluster Environment - 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
Get
Kafka Cluster Network[] (Optional Configuration Block) supports the following:
- rbac
Crn 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.- rest
Endpoint string (Required String) The REST endpoint of the Kafka cluster (e.g.,
https://pkc-00000.us-central1.gcp.confluent.cloud:443
).- basics
Get
Kafka Cluster Basic[] (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- dedicated
Get
Kafka Cluster Dedicated (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
- enterprises
Get
Kafka Cluster Enterprise[] (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- standards
Get
Kafka Cluster Standard[] (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
andMULTI_ZONE
.- 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[GetKafka Cluster Byok Key] (Optional Configuration Block) supports the following:
- cloud str
(Required String) The cloud service provider that runs the Kafka cluster. Accepted values are:
AWS
,AZURE
, andGCP
.- display_
name str (Required String) The name of the Kafka cluster.
- environment
Get
Kafka Cluster Environment - 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[Get
Kafka Cluster Network] (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[Get
Kafka Cluster Basic] (Optional Configuration Block) The configuration of the Basic Kafka cluster.
- dedicated
Get
Kafka Cluster Dedicated (Optional Configuration Block) The configuration of the Dedicated Kafka cluster. It supports the following:
- enterprises
Sequence[Get
Kafka Cluster Enterprise] (Optional Configuration Block) The configuration of the Enterprise Kafka cluster.
- standards
Sequence[Get
Kafka Cluster Standard] (Optional Configuration Block) The configuration of the Standard Kafka cluster.
- api
Version 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
andMULTI_ZONE
.- bootstrap
Endpoint 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
).- byok
Keys 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
, andGCP
.- display
Name 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:
- rbac
Crn 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.- rest
Endpoint 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.
- standards List<Property Map>
(Optional Configuration Block) The configuration of the Standard Kafka cluster.
Supporting Types
GetKafkaClusterByokKey
- Id string
The ID of the Environment that the Kafka cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_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
anddisplay_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
anddisplay_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
anddisplay_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
anddisplay_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
anddisplay_name
attributes must be specified.
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 is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- Encryption
Key string - 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 is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- Encryption
Key string - 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 is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- encryption
Key String - 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 is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- encryption
Key string - 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 is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- encryption_
key str - 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 is1
whereasMULTI_ZONE
dedicated clusters must have more than2
CKUs.- encryption
Key String - 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
anddisplay_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
anddisplay_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
anddisplay_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
anddisplay_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
anddisplay_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
anddisplay_name
attributes must be specified.
GetKafkaClusterNetwork
- Id string
The ID of the Environment that the Kafka cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_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
anddisplay_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
anddisplay_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
anddisplay_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
anddisplay_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
anddisplay_name
attributes must be specified.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
confluent
Terraform Provider.