confluentcloud.getKsqlCluster
Explore with Pulumi AI
# confluentcloud.KsqlCluster Data Source
confluentcloud.KsqlCluster
describes a ksqlDB cluster data source.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;
return await Deployment.RunAsync(() =>
{
var exampleUsingIdKsqlCluster = ConfluentCloud.GetKsqlCluster.Invoke(new()
{
Id = "lksqlc-abc123",
Environment = new ConfluentCloud.Inputs.GetKsqlClusterEnvironmentInputArgs
{
Id = "env-xyz456",
},
});
var exampleUsingNameKsqlCluster = ConfluentCloud.GetKsqlCluster.Invoke(new()
{
DisplayName = "ksqldb_cluster",
Environment = new ConfluentCloud.Inputs.GetKsqlClusterEnvironmentInputArgs
{
Id = "env-xyz456",
},
});
return new Dictionary<string, object?>
{
["exampleUsingId"] = exampleUsingIdKsqlCluster,
["exampleUsingName"] = exampleUsingNameKsqlCluster,
};
});
package main
import (
"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 {
exampleUsingIdKsqlCluster, err := confluentcloud.LookupKsqlCluster(ctx, &confluentcloud.LookupKsqlClusterArgs{
Id: pulumi.StringRef("lksqlc-abc123"),
Environment: confluentcloud.GetKsqlClusterEnvironment{
Id: "env-xyz456",
},
}, nil)
if err != nil {
return err
}
ctx.Export("exampleUsingId", exampleUsingIdKsqlCluster)
exampleUsingNameKsqlCluster, err := confluentcloud.LookupKsqlCluster(ctx, &confluentcloud.LookupKsqlClusterArgs{
DisplayName: pulumi.StringRef("ksqldb_cluster"),
Environment: confluentcloud.GetKsqlClusterEnvironment{
Id: "env-xyz456",
},
}, nil)
if err != nil {
return err
}
ctx.Export("exampleUsingName", exampleUsingNameKsqlCluster)
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.GetKsqlClusterArgs;
import com.pulumi.confluentcloud.inputs.GetKsqlClusterEnvironmentArgs;
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 exampleUsingIdKsqlCluster = ConfluentcloudFunctions.getKsqlCluster(GetKsqlClusterArgs.builder()
.id("lksqlc-abc123")
.environment(GetKsqlClusterEnvironmentArgs.builder()
.id("env-xyz456")
.build())
.build());
ctx.export("exampleUsingId", exampleUsingIdKsqlCluster.applyValue(getKsqlClusterResult -> getKsqlClusterResult));
final var exampleUsingNameKsqlCluster = ConfluentcloudFunctions.getKsqlCluster(GetKsqlClusterArgs.builder()
.displayName("ksqldb_cluster")
.environment(GetKsqlClusterEnvironmentArgs.builder()
.id("env-xyz456")
.build())
.build());
ctx.export("exampleUsingName", exampleUsingNameKsqlCluster.applyValue(getKsqlClusterResult -> getKsqlClusterResult));
}
}
import pulumi
import pulumi_confluentcloud as confluentcloud
example_using_id_ksql_cluster = confluentcloud.get_ksql_cluster(id="lksqlc-abc123",
environment=confluentcloud.GetKsqlClusterEnvironmentArgs(
id="env-xyz456",
))
pulumi.export("exampleUsingId", example_using_id_ksql_cluster)
example_using_name_ksql_cluster = confluentcloud.get_ksql_cluster(display_name="ksqldb_cluster",
environment=confluentcloud.GetKsqlClusterEnvironmentArgs(
id="env-xyz456",
))
pulumi.export("exampleUsingName", example_using_name_ksql_cluster)
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const exampleUsingIdKsqlCluster = confluentcloud.getKsqlCluster({
id: "lksqlc-abc123",
environment: {
id: "env-xyz456",
},
});
export const exampleUsingId = exampleUsingIdKsqlCluster;
const exampleUsingNameKsqlCluster = confluentcloud.getKsqlCluster({
displayName: "ksqldb_cluster",
environment: {
id: "env-xyz456",
},
});
export const exampleUsingName = exampleUsingNameKsqlCluster;
variables:
exampleUsingIdKsqlCluster:
fn::invoke:
Function: confluentcloud:getKsqlCluster
Arguments:
id: lksqlc-abc123
environment:
id: env-xyz456
exampleUsingNameKsqlCluster:
fn::invoke:
Function: confluentcloud:getKsqlCluster
Arguments:
displayName: ksqldb_cluster
environment:
id: env-xyz456
outputs:
exampleUsingId: ${exampleUsingIdKsqlCluster}
exampleUsingName: ${exampleUsingNameKsqlCluster}
Using getKsqlCluster
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 getKsqlCluster(args: GetKsqlClusterArgs, opts?: InvokeOptions): Promise<GetKsqlClusterResult>
function getKsqlClusterOutput(args: GetKsqlClusterOutputArgs, opts?: InvokeOptions): Output<GetKsqlClusterResult>
def get_ksql_cluster(display_name: Optional[str] = None,
environment: Optional[GetKsqlClusterEnvironment] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetKsqlClusterResult
def get_ksql_cluster_output(display_name: Optional[pulumi.Input[str]] = None,
environment: Optional[pulumi.Input[GetKsqlClusterEnvironmentArgs]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetKsqlClusterResult]
func LookupKsqlCluster(ctx *Context, args *LookupKsqlClusterArgs, opts ...InvokeOption) (*LookupKsqlClusterResult, error)
func LookupKsqlClusterOutput(ctx *Context, args *LookupKsqlClusterOutputArgs, opts ...InvokeOption) LookupKsqlClusterResultOutput
> Note: This function is named LookupKsqlCluster
in the Go SDK.
public static class GetKsqlCluster
{
public static Task<GetKsqlClusterResult> InvokeAsync(GetKsqlClusterArgs args, InvokeOptions? opts = null)
public static Output<GetKsqlClusterResult> Invoke(GetKsqlClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKsqlClusterResult> getKsqlCluster(GetKsqlClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: confluentcloud:index/getKsqlCluster:getKsqlCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Environment
Pulumi.
Confluent Cloud. Inputs. Get Ksql Cluster Environment - Display
Name string The name of the ksqlDB cluster.
- Id string
The ID of the Environment that the ksqlDB cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- Environment
Get
Ksql Cluster Environment - Display
Name string The name of the ksqlDB cluster.
- Id string
The ID of the Environment that the ksqlDB cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- environment
Get
Ksql Cluster Environment - display
Name String The name of the ksqlDB cluster.
- id String
The ID of the Environment that the ksqlDB cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- environment
Get
Ksql Cluster Environment - display
Name string The name of the ksqlDB cluster.
- id string
The ID of the Environment that the ksqlDB cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- environment
Get
Ksql Cluster Environment - display_
name str The name of the ksqlDB cluster.
- id str
The ID of the Environment that the ksqlDB cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
- environment Property Map
- display
Name String The name of the ksqlDB cluster.
- id String
The ID of the Environment that the ksqlDB cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
getKsqlCluster Result
The following output properties are available:
- Api
Version string (Required String) An API Version of the schema version of the ksqlDB cluster, for example,
ksqldbcm/v2
.- Credential
Identities List<Pulumi.Confluent Cloud. Outputs. Get Ksql Cluster Credential Identity> (Optional Configuration Block) supports the following:
- Csu int
(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
- Display
Name string - Environment
Pulumi.
Confluent Cloud. Outputs. Get Ksql Cluster Environment - Id string
(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example,
sa-abc123
.- Kafka
Clusters List<Pulumi.Confluent Cloud. Outputs. Get Ksql Cluster Kafka Cluster> (Optional Configuration Block) supports the following:
- Kind string
(Required String) A kind of the ksqlDB cluster, for example,
Cluster
.- Resource
Name string (Required String) The Confluent Resource Name of the ksqlDB cluster.
- Rest
Endpoint string (Required String) The API endpoint of the ksqlDB cluster, for example,
https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud
.- Storage int
(Required Integer) The amount of storage (in GB) provisioned to this cluster.
- Topic
Prefix string (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example,
pksqlc-00000
.- Use
Detailed boolProcessing Log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
- Api
Version string (Required String) An API Version of the schema version of the ksqlDB cluster, for example,
ksqldbcm/v2
.- Credential
Identities []GetKsql Cluster Credential Identity (Optional Configuration Block) supports the following:
- Csu int
(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
- Display
Name string - Environment
Get
Ksql Cluster Environment - Id string
(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example,
sa-abc123
.- Kafka
Clusters []GetKsql Cluster Kafka Cluster (Optional Configuration Block) supports the following:
- Kind string
(Required String) A kind of the ksqlDB cluster, for example,
Cluster
.- Resource
Name string (Required String) The Confluent Resource Name of the ksqlDB cluster.
- Rest
Endpoint string (Required String) The API endpoint of the ksqlDB cluster, for example,
https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud
.- Storage int
(Required Integer) The amount of storage (in GB) provisioned to this cluster.
- Topic
Prefix string (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example,
pksqlc-00000
.- Use
Detailed boolProcessing Log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
- api
Version String (Required String) An API Version of the schema version of the ksqlDB cluster, for example,
ksqldbcm/v2
.- credential
Identities List<GetKsql Cluster Credential Identity> (Optional Configuration Block) supports the following:
- csu Integer
(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
- display
Name String - environment
Get
Ksql Cluster Environment - id String
(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example,
sa-abc123
.- kafka
Clusters List<GetKsql Cluster Kafka Cluster> (Optional Configuration Block) supports the following:
- kind String
(Required String) A kind of the ksqlDB cluster, for example,
Cluster
.- resource
Name String (Required String) The Confluent Resource Name of the ksqlDB cluster.
- rest
Endpoint String (Required String) The API endpoint of the ksqlDB cluster, for example,
https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud
.- storage Integer
(Required Integer) The amount of storage (in GB) provisioned to this cluster.
- topic
Prefix String (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example,
pksqlc-00000
.- use
Detailed BooleanProcessing Log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
- api
Version string (Required String) An API Version of the schema version of the ksqlDB cluster, for example,
ksqldbcm/v2
.- credential
Identities GetKsql Cluster Credential Identity[] (Optional Configuration Block) supports the following:
- csu number
(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
- display
Name string - environment
Get
Ksql Cluster Environment - id string
(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example,
sa-abc123
.- kafka
Clusters GetKsql Cluster Kafka Cluster[] (Optional Configuration Block) supports the following:
- kind string
(Required String) A kind of the ksqlDB cluster, for example,
Cluster
.- resource
Name string (Required String) The Confluent Resource Name of the ksqlDB cluster.
- rest
Endpoint string (Required String) The API endpoint of the ksqlDB cluster, for example,
https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud
.- storage number
(Required Integer) The amount of storage (in GB) provisioned to this cluster.
- topic
Prefix string (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example,
pksqlc-00000
.- use
Detailed booleanProcessing Log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
- api_
version str (Required String) An API Version of the schema version of the ksqlDB cluster, for example,
ksqldbcm/v2
.- credential_
identities Sequence[GetKsql Cluster Credential Identity] (Optional Configuration Block) supports the following:
- csu int
(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
- display_
name str - environment
Get
Ksql Cluster Environment - id str
(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example,
sa-abc123
.- kafka_
clusters Sequence[GetKsql Cluster Kafka Cluster] (Optional Configuration Block) supports the following:
- kind str
(Required String) A kind of the ksqlDB cluster, for example,
Cluster
.- resource_
name str (Required String) The Confluent Resource Name of the ksqlDB cluster.
- rest_
endpoint str (Required String) The API endpoint of the ksqlDB cluster, for example,
https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud
.- storage int
(Required Integer) The amount of storage (in GB) provisioned to this cluster.
- topic_
prefix str (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example,
pksqlc-00000
.- use_
detailed_ boolprocessing_ log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
- api
Version String (Required String) An API Version of the schema version of the ksqlDB cluster, for example,
ksqldbcm/v2
.- credential
Identities List<Property Map> (Optional Configuration Block) supports the following:
- csu Number
(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
- display
Name String - environment Property Map
- id String
(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example,
sa-abc123
.- kafka
Clusters List<Property Map> (Optional Configuration Block) supports the following:
- kind String
(Required String) A kind of the ksqlDB cluster, for example,
Cluster
.- resource
Name String (Required String) The Confluent Resource Name of the ksqlDB cluster.
- rest
Endpoint String (Required String) The API endpoint of the ksqlDB cluster, for example,
https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud
.- storage Number
(Required Integer) The amount of storage (in GB) provisioned to this cluster.
- topic
Prefix String (Required String) Topic name prefix used by this ksqlDB cluster. Used to assign ACLs for this ksqlDB cluster to use, for example,
pksqlc-00000
.- use
Detailed BooleanProcessing Log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
Supporting Types
GetKsqlClusterCredentialIdentity
- Id string
The ID of the Environment that the ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
GetKsqlClusterEnvironment
- Id string
The ID of the Environment that the ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB cluster belongs to, for example,
env-xyz456
.Note: Exactly one from the
id
anddisplay_name
attributes must be specified.
GetKsqlClusterKafkaCluster
- Id string
The ID of the Environment that the ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB 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.