Confluent Cloud

v1.3.0 published on Wednesday, Sep 14, 2022 by Pulumi

getKsqlCluster

# confluentcloud.KsqlCluster Data Source

Open Preview

confluentcloud.KsqlCluster describes a ksqlDB cluster data source.

Example Usage

using System.Collections.Generic;
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.Apply(getKsqlClusterResult => getKsqlClusterResult),
        ["exampleUsingName"] = exampleUsingNameKsqlCluster.Apply(getKsqlClusterResult => getKsqlClusterResult),
    };
});
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, &GetKsqlClusterArgs{
			Id: pulumi.StringRef("lksqlc-abc123"),
			Environment: GetKsqlClusterEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingId", exampleUsingIdKsqlCluster)
		exampleUsingNameKsqlCluster, err := confluentcloud.LookupKsqlCluster(ctx, &GetKsqlClusterArgs{
			DisplayName: pulumi.StringRef("ksqldb_cluster"),
			Environment: 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.ConfluentCloud.Inputs.GetKsqlClusterEnvironment
DisplayName string

The name of the ksqlDB cluster.

Id string

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

Environment GetKsqlClusterEnvironment
DisplayName string

The name of the ksqlDB cluster.

Id string

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

environment GetKsqlClusterEnvironment
displayName String

The name of the ksqlDB cluster.

id String

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

environment GetKsqlClusterEnvironment
displayName string

The name of the ksqlDB cluster.

id string

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

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

environment Property Map
displayName String

The name of the ksqlDB cluster.

id String

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

getKsqlCluster Result

The following output properties are available:

ApiVersion string

(Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

CredentialIdentities List<Pulumi.ConfluentCloud.Outputs.GetKsqlClusterCredentialIdentity>
Csu int

(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.

  • use_detailed_processing_log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
DisplayName string
Environment Pulumi.ConfluentCloud.Outputs.GetKsqlClusterEnvironment
HttpEndpoint string

(Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

  • kafka_cluster (Optional Configuration Block) supports the following:
Id string

(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example, sa-abc123.

KafkaClusters List<Pulumi.ConfluentCloud.Outputs.GetKsqlClusterKafkaCluster>
Kind string

(Required String) A kind of the ksqlDB cluster, for example, Cluster.

Storage int

(Required Integer) The amount of storage (in GB) provisioned to this cluster.

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

UseDetailedProcessingLog bool
ApiVersion string

(Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

CredentialIdentities []GetKsqlClusterCredentialIdentity
Csu int

(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.

  • use_detailed_processing_log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
DisplayName string
Environment GetKsqlClusterEnvironment
HttpEndpoint string

(Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

  • kafka_cluster (Optional Configuration Block) supports the following:
Id string

(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example, sa-abc123.

KafkaClusters []GetKsqlClusterKafkaCluster
Kind string

(Required String) A kind of the ksqlDB cluster, for example, Cluster.

Storage int

(Required Integer) The amount of storage (in GB) provisioned to this cluster.

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

UseDetailedProcessingLog bool
apiVersion String

(Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

credentialIdentities List<GetKsqlClusterCredentialIdentity>
csu Integer

(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.

  • use_detailed_processing_log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
displayName String
environment GetKsqlClusterEnvironment
httpEndpoint String

(Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

  • kafka_cluster (Optional Configuration Block) supports the following:
id String

(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example, sa-abc123.

kafkaClusters List<GetKsqlClusterKafkaCluster>
kind String

(Required String) A kind of the ksqlDB cluster, for example, Cluster.

storage Integer

(Required Integer) The amount of storage (in GB) provisioned to this cluster.

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

useDetailedProcessingLog Boolean
apiVersion string

(Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

credentialIdentities GetKsqlClusterCredentialIdentity[]
csu number

(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.

  • use_detailed_processing_log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
displayName string
environment GetKsqlClusterEnvironment
httpEndpoint string

(Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

  • kafka_cluster (Optional Configuration Block) supports the following:
id string

(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example, sa-abc123.

kafkaClusters GetKsqlClusterKafkaCluster[]
kind string

(Required String) A kind of the ksqlDB cluster, for example, Cluster.

storage number

(Required Integer) The amount of storage (in GB) provisioned to this cluster.

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

useDetailedProcessingLog boolean
api_version str

(Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

credential_identities Sequence[GetKsqlClusterCredentialIdentity]
csu int

(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.

  • use_detailed_processing_log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
display_name str
environment GetKsqlClusterEnvironment
http_endpoint str

(Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

  • kafka_cluster (Optional Configuration Block) supports the following:
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[GetKsqlClusterKafkaCluster]
kind str

(Required String) A kind of the ksqlDB cluster, for example, Cluster.

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_processing_log bool
apiVersion String

(Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.

credentialIdentities List<Property Map>
csu Number

(Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.

  • use_detailed_processing_log (Optional Boolean) Controls whether the row data should be included in the processing log topic.
displayName String
environment Property Map
httpEndpoint String

(Required String) The API endpoint of the ksqlDB cluster, for example, https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud.

  • kafka_cluster (Optional Configuration Block) supports the following:
id String

(Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example, sa-abc123.

kafkaClusters List<Property Map>
kind String

(Required String) A kind of the ksqlDB cluster, for example, Cluster.

storage Number

(Required Integer) The amount of storage (in GB) provisioned to this cluster.

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

useDetailedProcessingLog Boolean

Supporting Types

GetKsqlClusterCredentialIdentity

Id string

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

Id string

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

id String

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

id string

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

id str

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

id String

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

GetKsqlClusterEnvironment

Id string

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

Id string

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

id String

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

id string

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

id str

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

id String

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

GetKsqlClusterKafkaCluster

Id string

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

Id string

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

id String

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

id string

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

id str

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

id String

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

Package Details

Repository
https://github.com/pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes

This Pulumi package is based on the confluent Terraform Provider.