1. Packages
  2. Confluent Cloud
  3. API Docs
  4. getKsqlCluster
Confluent v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi

confluentcloud.getKsqlCluster

Explore with Pulumi AI

confluentcloud logo
Confluent v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi

    # confluentcloud.KsqlCluster Data Source

    General Availability

    confluentcloud.KsqlCluster describes a ksqlDB cluster data source.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    export = async () => {
        const exampleUsingId = await confluentcloud.getKsqlCluster({
            id: "lksqlc-abc123",
            environment: {
                id: "env-xyz456",
            },
        });
        const exampleUsingName = await confluentcloud.getKsqlCluster({
            displayName: "ksqldb_cluster",
            environment: {
                id: "env-xyz456",
            },
        });
        return {
            exampleUsingId: exampleUsingId,
            exampleUsingName: exampleUsingName,
        };
    }
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    example_using_id = confluentcloud.get_ksql_cluster(id="lksqlc-abc123",
        environment=confluentcloud.GetKsqlClusterEnvironmentArgs(
            id="env-xyz456",
        ))
    pulumi.export("exampleUsingId", example_using_id)
    example_using_name = confluentcloud.get_ksql_cluster(display_name="ksqldb_cluster",
        environment=confluentcloud.GetKsqlClusterEnvironmentArgs(
            id="env-xyz456",
        ))
    pulumi.export("exampleUsingName", example_using_name)
    
    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 {
    		exampleUsingId, 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", exampleUsingId)
    		exampleUsingName, 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", exampleUsingName)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ConfluentCloud = Pulumi.ConfluentCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleUsingId = ConfluentCloud.GetKsqlCluster.Invoke(new()
        {
            Id = "lksqlc-abc123",
            Environment = new ConfluentCloud.Inputs.GetKsqlClusterEnvironmentInputArgs
            {
                Id = "env-xyz456",
            },
        });
    
        var exampleUsingName = ConfluentCloud.GetKsqlCluster.Invoke(new()
        {
            DisplayName = "ksqldb_cluster",
            Environment = new ConfluentCloud.Inputs.GetKsqlClusterEnvironmentInputArgs
            {
                Id = "env-xyz456",
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["exampleUsingId"] = exampleUsingId,
            ["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.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 exampleUsingId = ConfluentcloudFunctions.getKsqlCluster(GetKsqlClusterArgs.builder()
                .id("lksqlc-abc123")
                .environment(GetKsqlClusterEnvironmentArgs.builder()
                    .id("env-xyz456")
                    .build())
                .build());
    
            ctx.export("exampleUsingId", exampleUsingId.applyValue(getKsqlClusterResult -> getKsqlClusterResult));
            final var exampleUsingName = ConfluentcloudFunctions.getKsqlCluster(GetKsqlClusterArgs.builder()
                .displayName("ksqldb_cluster")
                .environment(GetKsqlClusterEnvironmentArgs.builder()
                    .id("env-xyz456")
                    .build())
                .build());
    
            ctx.export("exampleUsingName", exampleUsingName.applyValue(getKsqlClusterResult -> getKsqlClusterResult));
        }
    }
    
    variables:
      exampleUsingId:
        fn::invoke:
          Function: confluentcloud:getKsqlCluster
          Arguments:
            id: lksqlc-abc123
            environment:
              id: env-xyz456
      exampleUsingName:
        fn::invoke:
          Function: confluentcloud:getKsqlCluster
          Arguments:
            displayName: ksqldb_cluster
            environment:
              id: env-xyz456
    outputs:
      exampleUsingId: ${exampleUsingId}
      exampleUsingName: ${exampleUsingName}
    

    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 ksqlDB cluster, for example, lksqlc-abc123.
    Environment GetKsqlClusterEnvironment
    DisplayName string
    The name of the ksqlDB cluster.
    Id string
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.
    environment GetKsqlClusterEnvironment
    displayName String
    The name of the ksqlDB cluster.
    id String
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.
    environment GetKsqlClusterEnvironment
    displayName string
    The name of the ksqlDB cluster.
    id string
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.
    environment GetKsqlClusterEnvironment
    display_name str
    The name of the ksqlDB cluster.
    id str
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.
    environment Property Map
    displayName String
    The name of the ksqlDB cluster.
    id String
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.

    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>
    (Optional Configuration Block) supports the following:
    Csu int
    (Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
    DisplayName string
    Environment Pulumi.ConfluentCloud.Outputs.GetKsqlClusterEnvironment
    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>
    (Optional Configuration Block) supports the following:
    Kind string
    (Required String) A kind of the ksqlDB cluster, for example, Cluster.
    ResourceName string
    (Required String) The Confluent Resource Name of the ksqlDB cluster.
    RestEndpoint 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.
    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
    (Optional Boolean) Controls whether the row data should be included in the processing log topic.
    ApiVersion string
    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.
    CredentialIdentities []GetKsqlClusterCredentialIdentity
    (Optional Configuration Block) supports the following:
    Csu int
    (Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
    DisplayName string
    Environment GetKsqlClusterEnvironment
    Id string
    (Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example, sa-abc123.
    KafkaClusters []GetKsqlClusterKafkaCluster
    (Optional Configuration Block) supports the following:
    Kind string
    (Required String) A kind of the ksqlDB cluster, for example, Cluster.
    ResourceName string
    (Required String) The Confluent Resource Name of the ksqlDB cluster.
    RestEndpoint 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.
    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
    (Optional Boolean) Controls whether the row data should be included in the processing log topic.
    apiVersion String
    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.
    credentialIdentities List<GetKsqlClusterCredentialIdentity>
    (Optional Configuration Block) supports the following:
    csu Integer
    (Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
    displayName String
    environment GetKsqlClusterEnvironment
    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>
    (Optional Configuration Block) supports the following:
    kind String
    (Required String) A kind of the ksqlDB cluster, for example, Cluster.
    resourceName String
    (Required String) The Confluent Resource Name of the ksqlDB cluster.
    restEndpoint 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.
    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
    (Optional Boolean) Controls whether the row data should be included in the processing log topic.
    apiVersion string
    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.
    credentialIdentities GetKsqlClusterCredentialIdentity[]
    (Optional Configuration Block) supports the following:
    csu number
    (Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
    displayName string
    environment GetKsqlClusterEnvironment
    id string
    (Required String) The ID of the service or user account that the ksqlDB cluster belongs to, for example, sa-abc123.
    kafkaClusters GetKsqlClusterKafkaCluster[]
    (Optional Configuration Block) supports the following:
    kind string
    (Required String) A kind of the ksqlDB cluster, for example, Cluster.
    resourceName string
    (Required String) The Confluent Resource Name of the ksqlDB cluster.
    restEndpoint 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.
    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
    (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[GetKsqlClusterCredentialIdentity]
    (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 GetKsqlClusterEnvironment
    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]
    (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_processing_log bool
    (Optional Boolean) Controls whether the row data should be included in the processing log topic.
    apiVersion String
    (Required String) An API Version of the schema version of the ksqlDB cluster, for example, ksqldbcm/v2.
    credentialIdentities List<Property Map>
    (Optional Configuration Block) supports the following:
    csu Number
    (Required Number) The number of CSUs (Confluent Streaming Units) in the ksqlDB cluster.
    displayName 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.
    kafkaClusters List<Property Map>
    (Optional Configuration Block) supports the following:
    kind String
    (Required String) A kind of the ksqlDB cluster, for example, Cluster.
    resourceName String
    (Required String) The Confluent Resource Name of the ksqlDB cluster.
    restEndpoint 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.
    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
    (Optional Boolean) Controls whether the row data should be included in the processing log topic.

    Supporting Types

    GetKsqlClusterCredentialIdentity

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

    GetKsqlClusterEnvironment

    Id string

    The ID of the Environment that the ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB 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 ksqlDB cluster belongs to, for example, env-xyz456.

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

    GetKsqlClusterKafkaCluster

    Id string
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.
    Id string
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.
    id String
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.
    id string
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.
    id str
    The ID of the ksqlDB cluster, for example, lksqlc-abc123.
    id String
    The ID of the ksqlDB cluster, for example, lksqlc-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 v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi