AWS Cloud Control v1.26.0, Mar 12 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

aws-native.msk.getCluster

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>

def get_cluster(arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(arn: Optional[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-native:msk:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string: The Amazon Resource Name (ARN) of the MSK cluster.

Arn string: The Amazon Resource Name (ARN) of the MSK cluster.

arn String: The Amazon Resource Name (ARN) of the MSK cluster.

arn string: The Amazon Resource Name (ARN) of the MSK cluster.

arn str: The Amazon Resource Name (ARN) of the MSK cluster.

arn String: The Amazon Resource Name (ARN) of the MSK cluster.

getCluster Result

The following output properties are available:

Arn string: The Amazon Resource Name (ARN) of the MSK cluster.
BrokerNodeGroupInfo Pulumi.AwsNative.Msk.Outputs.ClusterBrokerNodeGroupInfo: Information about the broker nodes in the cluster.
ClientAuthentication Pulumi.AwsNative.Msk.Outputs.ClusterClientAuthentication: Includes all client authentication related information.
ConfigurationInfo Pulumi.AwsNative.Msk.Outputs.ClusterConfigurationInfo: Represents the configuration that you want MSK to use for the cluster.
CurrentVersion string: The current version of the MSK cluster
EncryptionInfo Pulumi.AwsNative.Msk.Outputs.ClusterEncryptionInfo: Includes all encryption-related information.
EnhancedMonitoring Pulumi.AwsNative.Msk.ClusterEnhancedMonitoring: Specifies the level of monitoring for the MSK cluster.
KafkaVersion string: The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
LoggingInfo Pulumi.AwsNative.Msk.Outputs.ClusterLoggingInfo: Logging info details for the cluster.
NumberOfBrokerNodes int: The number of broker nodes in the cluster.
OpenMonitoring Pulumi.AwsNative.Msk.Outputs.ClusterOpenMonitoring: The settings for open monitoring.
StorageMode Pulumi.AwsNative.Msk.ClusterStorageMode: This controls storage mode for supported storage tiers.
Tags Dictionary<string, string>: A key-value pair to associate with a resource.

Arn string: The Amazon Resource Name (ARN) of the MSK cluster.
BrokerNodeGroupInfo ClusterBrokerNodeGroupInfo: Information about the broker nodes in the cluster.
ClientAuthentication ClusterClientAuthentication: Includes all client authentication related information.
ConfigurationInfo ClusterConfigurationInfo: Represents the configuration that you want MSK to use for the cluster.
CurrentVersion string: The current version of the MSK cluster
EncryptionInfo ClusterEncryptionInfo: Includes all encryption-related information.
EnhancedMonitoring ClusterEnhancedMonitoring: Specifies the level of monitoring for the MSK cluster.
KafkaVersion string: The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
LoggingInfo ClusterLoggingInfo: Logging info details for the cluster.
NumberOfBrokerNodes int: The number of broker nodes in the cluster.
OpenMonitoring ClusterOpenMonitoring: The settings for open monitoring.
StorageMode ClusterStorageMode: This controls storage mode for supported storage tiers.
Tags map[string]string: A key-value pair to associate with a resource.

arn String: The Amazon Resource Name (ARN) of the MSK cluster.
brokerNodeGroupInfo ClusterBrokerNodeGroupInfo: Information about the broker nodes in the cluster.
clientAuthentication ClusterClientAuthentication: Includes all client authentication related information.
configurationInfo ClusterConfigurationInfo: Represents the configuration that you want MSK to use for the cluster.
currentVersion String: The current version of the MSK cluster
encryptionInfo ClusterEncryptionInfo: Includes all encryption-related information.
enhancedMonitoring ClusterEnhancedMonitoring: Specifies the level of monitoring for the MSK cluster.
kafkaVersion String: The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
loggingInfo ClusterLoggingInfo: Logging info details for the cluster.
numberOfBrokerNodes Integer: The number of broker nodes in the cluster.
openMonitoring ClusterOpenMonitoring: The settings for open monitoring.
storageMode ClusterStorageMode: This controls storage mode for supported storage tiers.
tags Map<String,String>: A key-value pair to associate with a resource.

arn string: The Amazon Resource Name (ARN) of the MSK cluster.
brokerNodeGroupInfo ClusterBrokerNodeGroupInfo: Information about the broker nodes in the cluster.
clientAuthentication ClusterClientAuthentication: Includes all client authentication related information.
configurationInfo ClusterConfigurationInfo: Represents the configuration that you want MSK to use for the cluster.
currentVersion string: The current version of the MSK cluster
encryptionInfo ClusterEncryptionInfo: Includes all encryption-related information.
enhancedMonitoring ClusterEnhancedMonitoring: Specifies the level of monitoring for the MSK cluster.
kafkaVersion string: The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
loggingInfo ClusterLoggingInfo: Logging info details for the cluster.
numberOfBrokerNodes number: The number of broker nodes in the cluster.
openMonitoring ClusterOpenMonitoring: The settings for open monitoring.
storageMode ClusterStorageMode: This controls storage mode for supported storage tiers.
tags {[key: string]: string}: A key-value pair to associate with a resource.

arn str: The Amazon Resource Name (ARN) of the MSK cluster.
broker_node_group_info ClusterBrokerNodeGroupInfo: Information about the broker nodes in the cluster.
client_authentication ClusterClientAuthentication: Includes all client authentication related information.
configuration_info ClusterConfigurationInfo: Represents the configuration that you want MSK to use for the cluster.
current_version str: The current version of the MSK cluster
encryption_info ClusterEncryptionInfo: Includes all encryption-related information.
enhanced_monitoring ClusterEnhancedMonitoring: Specifies the level of monitoring for the MSK cluster.
kafka_version str: The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
logging_info ClusterLoggingInfo: Logging info details for the cluster.
number_of_broker_nodes int: The number of broker nodes in the cluster.
open_monitoring ClusterOpenMonitoring: The settings for open monitoring.
storage_mode ClusterStorageMode: This controls storage mode for supported storage tiers.
tags Mapping[str, str]: A key-value pair to associate with a resource.

arn String: The Amazon Resource Name (ARN) of the MSK cluster.
brokerNodeGroupInfo Property Map: Information about the broker nodes in the cluster.
clientAuthentication Property Map: Includes all client authentication related information.
configurationInfo Property Map: Represents the configuration that you want MSK to use for the cluster.
currentVersion String: The current version of the MSK cluster
encryptionInfo Property Map: Includes all encryption-related information.
enhancedMonitoring "DEFAULT" | "PER_BROKER" | "PER_TOPIC_PER_BROKER" | "PER_TOPIC_PER_PARTITION": Specifies the level of monitoring for the MSK cluster.
kafkaVersion String: The version of Apache Kafka. You can use Amazon MSK to create clusters that use supported Apache Kafka versions .
loggingInfo Property Map: Logging info details for the cluster.
numberOfBrokerNodes Number: The number of broker nodes in the cluster.
openMonitoring Property Map: The settings for open monitoring.
storageMode "LOCAL" | "TIERED": This controls storage mode for supported storage tiers.
tags Map<String>: A key-value pair to associate with a resource.

Supporting Types

ClusterBrokerLogs

CloudWatchLogs Pulumi.AwsNative.Msk.Inputs.ClusterCloudWatchLogs
Firehose Pulumi.AwsNative.Msk.Inputs.ClusterFirehose
S3 Pulumi.AwsNative.Msk.Inputs.ClusterS3

CloudWatchLogs ClusterCloudWatchLogs
Firehose ClusterFirehose
S3 ClusterS3

cloudWatchLogs ClusterCloudWatchLogs
firehose ClusterFirehose
s3 ClusterS3

cloudWatchLogs ClusterCloudWatchLogs
firehose ClusterFirehose
s3 ClusterS3

cloud_watch_logs ClusterCloudWatchLogs
firehose ClusterFirehose
s3 ClusterS3

cloudWatchLogs Property Map
firehose Property Map
s3 Property Map

ClusterBrokerNodeGroupInfo

ClientSubnets List<string>

The list of subnets to connect to in the client virtual private cloud (VPC). Amazon creates elastic network interfaces (ENIs) inside these subnets. Client applications use ENIs to produce and consume data.

If you use the US West (N. California) Region, specify exactly two subnets. For other Regions where Amazon MSK is available, you can specify either two or three subnets. The subnets that you specify must be in distinct Availability Zones. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify.

Client subnets can't occupy the Availability Zone with ID use1-az3 .

InstanceType string

The type of Amazon EC2 instances to use for brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge, and kafka.t3.small.

BrokerAzDistribution string

This parameter is currently not in use.

ConnectivityInfo Pulumi.AwsNative.Msk.Inputs.ClusterConnectivityInfo

Information about the cluster's connectivity setting.

SecurityGroups List<string>

The security groups to associate with the ENIs in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC. If you specify security groups that were shared with you, you must ensure that you have permissions to them. Specifically, you need the ec2:DescribeSecurityGroups permission.

StorageInfo Pulumi.AwsNative.Msk.Inputs.ClusterStorageInfo

Contains information about storage volumes attached to Amazon MSK broker nodes.

ClientSubnets []string

Client subnets can't occupy the Availability Zone with ID use1-az3 .

InstanceType string

BrokerAzDistribution string

This parameter is currently not in use.

ConnectivityInfo ClusterConnectivityInfo

Information about the cluster's connectivity setting.

SecurityGroups []string

StorageInfo ClusterStorageInfo

Contains information about storage volumes attached to Amazon MSK broker nodes.

clientSubnets List<String>

Client subnets can't occupy the Availability Zone with ID use1-az3 .

instanceType String

brokerAzDistribution String

This parameter is currently not in use.

connectivityInfo ClusterConnectivityInfo

Information about the cluster's connectivity setting.

securityGroups List<String>

storageInfo ClusterStorageInfo

Contains information about storage volumes attached to Amazon MSK broker nodes.

clientSubnets string[]

Client subnets can't occupy the Availability Zone with ID use1-az3 .

instanceType string

brokerAzDistribution string

This parameter is currently not in use.

connectivityInfo ClusterConnectivityInfo

Information about the cluster's connectivity setting.

securityGroups string[]

storageInfo ClusterStorageInfo

Contains information about storage volumes attached to Amazon MSK broker nodes.

client_subnets Sequence[str]

Client subnets can't occupy the Availability Zone with ID use1-az3 .

instance_type str

broker_az_distribution str

This parameter is currently not in use.

connectivity_info ClusterConnectivityInfo

Information about the cluster's connectivity setting.

security_groups Sequence[str]

storage_info ClusterStorageInfo

Contains information about storage volumes attached to Amazon MSK broker nodes.

clientSubnets List<String>

Client subnets can't occupy the Availability Zone with ID use1-az3 .

instanceType String

brokerAzDistribution String

This parameter is currently not in use.

connectivityInfo Property Map

Information about the cluster's connectivity setting.

securityGroups List<String>

storageInfo Property Map

Contains information about storage volumes attached to Amazon MSK broker nodes.

ClusterClientAuthentication

Sasl Pulumi.AwsNative.Msk.Inputs.ClusterSasl
Tls Pulumi.AwsNative.Msk.Inputs.ClusterTls
Unauthenticated Pulumi.AwsNative.Msk.Inputs.ClusterUnauthenticated

Sasl ClusterSasl
Tls ClusterTls
Unauthenticated ClusterUnauthenticated

sasl ClusterSasl
tls ClusterTls
unauthenticated ClusterUnauthenticated

sasl ClusterSasl
tls ClusterTls
unauthenticated ClusterUnauthenticated

sasl ClusterSasl
tls ClusterTls
unauthenticated ClusterUnauthenticated

sasl Property Map
tls Property Map
unauthenticated Property Map

ClusterCloudWatchLogs

Enabled bool
LogGroup string

Enabled bool
LogGroup string

enabled Boolean
logGroup String

enabled boolean
logGroup string

enabled bool
log_group str

enabled Boolean
logGroup String

ClusterConfigurationInfo

Arn string
Revision int

Arn string
Revision int

arn String
revision Integer

arn string
revision number

arn str
revision int

arn String
revision Number

Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

TLS : Indicates that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

The default value is TLS .

InCluster bool

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

ClientBroker ClusterEncryptionInTransitClientBroker

Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

TLS : Indicates that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

The default value is TLS .

InCluster bool

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

clientBroker ClusterEncryptionInTransitClientBroker

Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

TLS : Indicates that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

The default value is TLS .

inCluster Boolean

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

clientBroker ClusterEncryptionInTransitClientBroker

Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

TLS : Indicates that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

The default value is TLS .

inCluster boolean

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

client_broker ClusterEncryptionInTransitClientBroker

Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

TLS : Indicates that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

The default value is TLS .

in_cluster bool

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

clientBroker "TLS" | "TLS_PLAINTEXT" | "PLAINTEXT"

Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

TLS : Indicates that client-broker communication is enabled with TLS only.
TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

The default value is TLS .

inCluster Boolean

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.