1. Docs
  2. Reference
  3. API
  4. AWS
  5. msk
  6. GetCluster

GetCluster

Get information on an Amazon MSK Cluster.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.Msk.GetCluster.InvokeAsync(new Aws.Msk.GetClusterArgs
        {
            ClusterName = "example",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/msk"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := msk.LookupCluster(ctx, &msk.LookupClusterArgs{
            ClusterName: "example",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

example = aws.msk.get_cluster(cluster_name="example")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.msk.getCluster({
    clusterName: "example",
}, { async: true }));

Using GetCluster

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function  get_cluster(cluster_name=None, tags=None, opts=None)
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)

Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster {
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterName string

Name of the cluster.

Tags Dictionary<string, string>

Map of key-value pairs assigned to the cluster.

ClusterName string

Name of the cluster.

Tags map[string]string

Map of key-value pairs assigned to the cluster.

clusterName string

Name of the cluster.

tags {[key: string]: string}

Map of key-value pairs assigned to the cluster.

cluster_name str

Name of the cluster.

tags Dict[str, str]

Map of key-value pairs assigned to the cluster.

GetCluster Result

The following output properties are available:

Arn string

Amazon Resource Name (ARN) of the MSK cluster.

BootstrapBrokers string

A comma separated list of one or more hostname:port pairs of Kafka brokers suitable to boostrap connectivity to the Kafka cluster.

BootstrapBrokersTls string

A comma separated list of one or more DNS names (or IPs) and TLS port pairs kafka brokers suitable to boostrap connectivity to the kafka cluster.

ClusterName string
Id string

The provider-assigned unique ID for this managed resource.

KafkaVersion string

Apache Kafka version.

NumberOfBrokerNodes int

Number of broker nodes in the cluster.

Tags Dictionary<string, string>

Map of key-value pairs assigned to the cluster.

ZookeeperConnectString string

A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster.

Arn string

Amazon Resource Name (ARN) of the MSK cluster.

BootstrapBrokers string

A comma separated list of one or more hostname:port pairs of Kafka brokers suitable to boostrap connectivity to the Kafka cluster.

BootstrapBrokersTls string

A comma separated list of one or more DNS names (or IPs) and TLS port pairs kafka brokers suitable to boostrap connectivity to the kafka cluster.

ClusterName string
Id string

The provider-assigned unique ID for this managed resource.

KafkaVersion string

Apache Kafka version.

NumberOfBrokerNodes int

Number of broker nodes in the cluster.

Tags map[string]string

Map of key-value pairs assigned to the cluster.

ZookeeperConnectString string

A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster.

arn string

Amazon Resource Name (ARN) of the MSK cluster.

bootstrapBrokers string

A comma separated list of one or more hostname:port pairs of Kafka brokers suitable to boostrap connectivity to the Kafka cluster.

bootstrapBrokersTls string

A comma separated list of one or more DNS names (or IPs) and TLS port pairs kafka brokers suitable to boostrap connectivity to the kafka cluster.

clusterName string
id string

The provider-assigned unique ID for this managed resource.

kafkaVersion string

Apache Kafka version.

numberOfBrokerNodes number

Number of broker nodes in the cluster.

tags {[key: string]: string}

Map of key-value pairs assigned to the cluster.

zookeeperConnectString string

A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster.

arn str

Amazon Resource Name (ARN) of the MSK cluster.

bootstrap_brokers str

A comma separated list of one or more hostname:port pairs of Kafka brokers suitable to boostrap connectivity to the Kafka cluster.

bootstrap_brokers_tls str

A comma separated list of one or more DNS names (or IPs) and TLS port pairs kafka brokers suitable to boostrap connectivity to the kafka cluster.

cluster_name str
id str

The provider-assigned unique ID for this managed resource.

kafka_version str

Apache Kafka version.

number_of_broker_nodes float

Number of broker nodes in the cluster.

tags Dict[str, str]

Map of key-value pairs assigned to the cluster.

zookeeper_connect_string str

A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.