AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
aws.msk.getCluster
Explore with Pulumi AI
Get information on an Amazon MSK Cluster.
Note: This data sources returns information on provisioned clusters.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.msk.getCluster({
    clusterName: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.msk.get_cluster(cluster_name="example")
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/msk"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var example = Aws.Msk.GetCluster.Invoke(new()
    {
        ClusterName = "example",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.msk.MskFunctions;
import com.pulumi.aws.msk.inputs.GetClusterArgs;
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 example = MskFunctions.getCluster(GetClusterArgs.builder()
            .clusterName("example")
            .build());
    }
}
variables:
  example:
    fn::invoke:
      function: aws:msk:getCluster
      arguments:
        clusterName: example
Using getCluster
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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>def get_cluster(cluster_name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput> Note: This function is named LookupCluster in the Go SDK.
public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
fn::invoke:
  function: aws:msk/getCluster:getCluster
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ClusterName string
- Name of the cluster.
- Dictionary<string, string>
- Map of key-value pairs assigned to the cluster.
- ClusterName string
- Name of the cluster.
- map[string]string
- Map of key-value pairs assigned to the cluster.
- clusterName String
- Name of the cluster.
- Map<String,String>
- Map of key-value pairs assigned to the cluster.
- clusterName string
- Name of the cluster.
- {[key: string]: string}
- Map of key-value pairs assigned to the cluster.
- cluster_name str
- Name of the cluster.
- Mapping[str, str]
- Map of key-value pairs assigned to the cluster.
- clusterName String
- Name of the cluster.
- Map<String>
- Map of key-value pairs assigned to the cluster.
getCluster Result
The following output properties are available:
- Arn string
- ARN of the MSK cluster.
- BootstrapBrokers string
- Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster. Contains a value if encryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts values alphabetically. AWS may not always return all endpoints so this value is not guaranteed to be stable across applies.
- BootstrapBrokers stringPublic Sasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringPublic Sasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringPublic Tls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringSasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringSasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringTls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BrokerNode List<GetGroup Infos Cluster Broker Node Group Info> 
- Configuration block for the broker nodes of the Kafka cluster.
- ClusterName string
- ClusterUuid string
- UUID of the MSK cluster, for use in IAM policies.
- Id string
- The provider-assigned unique ID for this managed resource.
- KafkaVersion string
- Apache Kafka version.
- NumberOf intBroker Nodes 
- Number of broker nodes in the cluster.
- Dictionary<string, string>
- Map of key-value pairs assigned to the cluster.
- ZookeeperConnect stringString 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphbetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- ZookeeperConnect stringString Tls 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- Arn string
- ARN of the MSK cluster.
- BootstrapBrokers string
- Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster. Contains a value if encryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts values alphabetically. AWS may not always return all endpoints so this value is not guaranteed to be stable across applies.
- BootstrapBrokers stringPublic Sasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringPublic Sasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringPublic Tls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringSasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringSasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BootstrapBrokers stringTls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- BrokerNode []GetGroup Infos Cluster Broker Node Group Info 
- Configuration block for the broker nodes of the Kafka cluster.
- ClusterName string
- ClusterUuid string
- UUID of the MSK cluster, for use in IAM policies.
- Id string
- The provider-assigned unique ID for this managed resource.
- KafkaVersion string
- Apache Kafka version.
- NumberOf intBroker Nodes 
- Number of broker nodes in the cluster.
- map[string]string
- Map of key-value pairs assigned to the cluster.
- ZookeeperConnect stringString 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphbetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- ZookeeperConnect stringString Tls 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- arn String
- ARN of the MSK cluster.
- bootstrapBrokers String
- Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster. Contains a value if encryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts values alphabetically. AWS may not always return all endpoints so this value is not guaranteed to be stable across applies.
- bootstrapBrokers StringPublic Sasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringPublic Sasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringPublic Tls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringSasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringSasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringTls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- brokerNode List<GetGroup Infos Cluster Broker Node Group Info> 
- Configuration block for the broker nodes of the Kafka cluster.
- clusterName String
- clusterUuid String
- UUID of the MSK cluster, for use in IAM policies.
- id String
- The provider-assigned unique ID for this managed resource.
- kafkaVersion String
- Apache Kafka version.
- numberOf IntegerBroker Nodes 
- Number of broker nodes in the cluster.
- Map<String,String>
- Map of key-value pairs assigned to the cluster.
- zookeeperConnect StringString 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphbetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- zookeeperConnect StringString Tls 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- arn string
- ARN of the MSK cluster.
- bootstrapBrokers string
- Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster. Contains a value if encryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts values alphabetically. AWS may not always return all endpoints so this value is not guaranteed to be stable across applies.
- bootstrapBrokers stringPublic Sasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers stringPublic Sasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers stringPublic Tls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers stringSasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers stringSasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers stringTls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- brokerNode GetGroup Infos Cluster Broker Node Group Info[] 
- Configuration block for the broker nodes of the Kafka cluster.
- clusterName string
- clusterUuid string
- UUID of the MSK cluster, for use in IAM policies.
- id string
- The provider-assigned unique ID for this managed resource.
- kafkaVersion string
- Apache Kafka version.
- numberOf numberBroker Nodes 
- Number of broker nodes in the cluster.
- {[key: string]: string}
- Map of key-value pairs assigned to the cluster.
- zookeeperConnect stringString 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphbetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- zookeeperConnect stringString Tls 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- arn str
- ARN of the MSK cluster.
- bootstrap_brokers str
- Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster. Contains a value if encryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts values alphabetically. AWS may not always return all endpoints so this value is not guaranteed to be stable across applies.
- bootstrap_brokers_ strpublic_ sasl_ iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrap_brokers_ strpublic_ sasl_ scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrap_brokers_ strpublic_ tls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrap_brokers_ strsasl_ iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrap_brokers_ strsasl_ scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrap_brokers_ strtls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- broker_node_ Sequence[Getgroup_ infos Cluster Broker Node Group Info] 
- Configuration block for the broker nodes of the Kafka cluster.
- cluster_name str
- cluster_uuid str
- UUID of the MSK cluster, for use in IAM policies.
- id str
- The provider-assigned unique ID for this managed resource.
- kafka_version str
- Apache Kafka version.
- number_of_ intbroker_ nodes 
- Number of broker nodes in the cluster.
- Mapping[str, str]
- Map of key-value pairs assigned to the cluster.
- zookeeper_connect_ strstring 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphbetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- zookeeper_connect_ strstring_ tls 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- arn String
- ARN of the MSK cluster.
- bootstrapBrokers String
- Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster. Contains a value if encryption_info.0.encryption_in_transit.0.client_brokeris set toPLAINTEXTorTLS_PLAINTEXT. The resource sorts values alphabetically. AWS may not always return all endpoints so this value is not guaranteed to be stable across applies.
- bootstrapBrokers StringPublic Sasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringPublic Sasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrueandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringPublic Tls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-3-public.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandbroker_node_group_info.0.connectivity_info.0.public_access.0.typeis set toSERVICE_PROVIDED_EIPSand the cluster fulfill all other requirements for public access. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringSasl Iam 
- One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.iamis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringSasl Scram 
- One or more DNS names (or IP addresses) and SASL SCRAM port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLSandclient_authentication.0.sasl.0.scramis set totrue. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- bootstrapBrokers StringTls 
- One or more DNS names (or IP addresses) and TLS port pairs. For example, b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094. This attribute will have a value ifencryption_info.0.encryption_in_transit.0.client_brokeris set toTLS_PLAINTEXTorTLS. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
- brokerNode List<Property Map>Group Infos 
- Configuration block for the broker nodes of the Kafka cluster.
- clusterName String
- clusterUuid String
- UUID of the MSK cluster, for use in IAM policies.
- id String
- The provider-assigned unique ID for this managed resource.
- kafkaVersion String
- Apache Kafka version.
- numberOf NumberBroker Nodes 
- Number of broker nodes in the cluster.
- Map<String>
- Map of key-value pairs assigned to the cluster.
- zookeeperConnect StringString 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphbetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
- zookeeperConnect StringString Tls 
- A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies.
Supporting Types
GetClusterBrokerNodeGroupInfo     
- azDistribution String
- clientSubnets List<String>
- connectivityInfos List<Property Map>
- instanceType String
- securityGroups List<String>
- storageInfos List<Property Map>
GetClusterBrokerNodeGroupInfoConnectivityInfo       
GetClusterBrokerNodeGroupInfoConnectivityInfoPublicAccess         
- Type string
- Type string
- type String
- type string
- type str
- type String
GetClusterBrokerNodeGroupInfoConnectivityInfoVpcConnectivity         
GetClusterBrokerNodeGroupInfoConnectivityInfoVpcConnectivityClientAuthentication           
- sasls List<Property Map>
- tls Boolean
GetClusterBrokerNodeGroupInfoConnectivityInfoVpcConnectivityClientAuthenticationSasl            
GetClusterBrokerNodeGroupInfoStorageInfo       
GetClusterBrokerNodeGroupInfoStorageInfoEbsStorageInfo          
GetClusterBrokerNodeGroupInfoStorageInfoEbsStorageInfoProvisionedThroughput            
- Enabled bool
- VolumeThroughput int
- Enabled bool
- VolumeThroughput int
- enabled Boolean
- volumeThroughput Integer
- enabled boolean
- volumeThroughput number
- enabled bool
- volume_throughput int
- enabled Boolean
- volumeThroughput Number
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.