Upstash v0.2.0 published on Wednesday, May 24, 2023 by Upstash
upstash.getKafkaCluster
Explore with Pulumi AI
Example Usage
using Pulumi;
using Upstash = Pulumi.Upstash;
class MyStack : Stack
{
    public MyStack()
    {
        var clusterData = Output.Create(Upstash.GetKafkaCluster.InvokeAsync(new Upstash.GetKafkaClusterArgs
        {
            ClusterId = resource.Upstash_kafka_cluster.ExampleCluster.Cluster_id,
        }));
    }
}
package main
import (
	"github.com/pulumi/pulumi-upstash/sdk/go/upstash"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/upstash/pulumi-upstash/sdk/go/upstash"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := upstash.LookupKafkaCluster(ctx, &GetKafkaClusterArgs{
			ClusterId: resource.Upstash_kafka_cluster.ExampleCluster.Cluster_id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var clusterData = Output.of(UpstashFunctions.getKafkaCluster(GetKafkaClusterArgs.builder()
            .clusterId(resource.upstash_kafka_cluster().exampleCluster().cluster_id())
            .build()));
    }
}
import pulumi
import pulumi_upstash as upstash
cluster_data = upstash.get_kafka_cluster(cluster_id=resource["upstash_kafka_cluster"]["exampleCluster"]["cluster_id"])
import * as pulumi from "@pulumi/pulumi";
import * as upstash from "@pulumi/upstash";
const clusterData = upstash.getKafkaCluster({
    clusterId: resource.upstash_kafka_cluster.exampleCluster.cluster_id,
});
variables:
  clusterData:
    Fn::Invoke:
      Function: upstash:getKafkaCluster
      Arguments:
        clusterId: ${resource.upstash_kafka_cluster.exampleCluster.cluster_id}
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(cluster_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetKafkaClusterResult
def get_kafka_cluster_output(cluster_id: Optional[pulumi.Input[str]] = 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: upstash:index/getKafkaCluster:getKafkaCluster
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Cluster
Id string 
- Cluster
Id string 
- cluster
Id String 
- cluster
Id string 
- cluster_
id str 
- cluster
Id String 
getKafkaCluster Result
The following output properties are available:
- Cluster
Id string - Cluster
Name string - Creation
Time int - Id string
 - The provider-assigned unique ID for this managed resource.
 - Max
Message intSize  - Max
Messages intPer Second  - Max
Partitions int - Max
Retention intSize  - Max
Retention intTime  - Multizone bool
 - Password string
 - Region string
 - Rest
Endpoint string - State string
 - Tcp
Endpoint string - Type string
 - Username string
 
- Cluster
Id string - Cluster
Name string - Creation
Time int - Id string
 - The provider-assigned unique ID for this managed resource.
 - Max
Message intSize  - Max
Messages intPer Second  - Max
Partitions int - Max
Retention intSize  - Max
Retention intTime  - Multizone bool
 - Password string
 - Region string
 - Rest
Endpoint string - State string
 - Tcp
Endpoint string - Type string
 - Username string
 
- cluster
Id String - cluster
Name String - creation
Time Integer - id String
 - The provider-assigned unique ID for this managed resource.
 - max
Message IntegerSize  - max
Messages IntegerPer Second  - max
Partitions Integer - max
Retention IntegerSize  - max
Retention IntegerTime  - multizone Boolean
 - password String
 - region String
 - rest
Endpoint String - state String
 - tcp
Endpoint String - type String
 - username String
 
- cluster
Id string - cluster
Name string - creation
Time number - id string
 - The provider-assigned unique ID for this managed resource.
 - max
Message numberSize  - max
Messages numberPer Second  - max
Partitions number - max
Retention numberSize  - max
Retention numberTime  - multizone boolean
 - password string
 - region string
 - rest
Endpoint string - state string
 - tcp
Endpoint string - type string
 - username string
 
- cluster_
id str - cluster_
name str - creation_
time int - id str
 - The provider-assigned unique ID for this managed resource.
 - max_
message_ intsize  - max_
messages_ intper_ second  - max_
partitions int - max_
retention_ intsize  - max_
retention_ inttime  - multizone bool
 - password str
 - region str
 - rest_
endpoint str - state str
 - tcp_
endpoint str - type str
 - username str
 
- cluster
Id String - cluster
Name String - creation
Time Number - id String
 - The provider-assigned unique ID for this managed resource.
 - max
Message NumberSize  - max
Messages NumberPer Second  - max
Partitions Number - max
Retention NumberSize  - max
Retention NumberTime  - multizone Boolean
 - password String
 - region String
 - rest
Endpoint String - state String
 - tcp
Endpoint String - type String
 - username String
 
Package Details
- Repository
 - upstash upstash/pulumi-upstash
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
upstashTerraform Provider.