aws-native.msk.getCluster

Explore with Pulumi AI

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

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(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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:msk:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string

Arn string

arn String

arn string

arn str

arn String

getCluster Result

The following output properties are available:

Arn string
BrokerNodeGroupInfo Pulumi.AwsNative.Msk.Outputs.ClusterBrokerNodeGroupInfo
ClientAuthentication Pulumi.AwsNative.Msk.Outputs.ClusterClientAuthentication
ConfigurationInfo Pulumi.AwsNative.Msk.Outputs.ClusterConfigurationInfo
CurrentVersion string: The current version of the MSK cluster
EncryptionInfo Pulumi.AwsNative.Msk.Outputs.ClusterEncryptionInfo
EnhancedMonitoring Pulumi.AwsNative.Msk.ClusterEnhancedMonitoring
KafkaVersion string
LoggingInfo Pulumi.AwsNative.Msk.Outputs.ClusterLoggingInfo
NumberOfBrokerNodes int
OpenMonitoring Pulumi.AwsNative.Msk.Outputs.ClusterOpenMonitoring
StorageMode Pulumi.AwsNative.Msk.ClusterStorageMode
Tags Dictionary<string, string>: A key-value pair to associate with a resource.

Arn string
BrokerNodeGroupInfo ClusterBrokerNodeGroupInfo
ClientAuthentication ClusterClientAuthentication
ConfigurationInfo ClusterConfigurationInfo
CurrentVersion string: The current version of the MSK cluster
EncryptionInfo ClusterEncryptionInfo
EnhancedMonitoring ClusterEnhancedMonitoring
KafkaVersion string
LoggingInfo ClusterLoggingInfo
NumberOfBrokerNodes int
OpenMonitoring ClusterOpenMonitoring
StorageMode ClusterStorageMode
Tags map[string]string: A key-value pair to associate with a resource.

arn String
brokerNodeGroupInfo ClusterBrokerNodeGroupInfo
clientAuthentication ClusterClientAuthentication
configurationInfo ClusterConfigurationInfo
currentVersion String: The current version of the MSK cluster
encryptionInfo ClusterEncryptionInfo
enhancedMonitoring ClusterEnhancedMonitoring
kafkaVersion String
loggingInfo ClusterLoggingInfo
numberOfBrokerNodes Integer
openMonitoring ClusterOpenMonitoring
storageMode ClusterStorageMode
tags Map<String,String>: A key-value pair to associate with a resource.

arn string
brokerNodeGroupInfo ClusterBrokerNodeGroupInfo
clientAuthentication ClusterClientAuthentication
configurationInfo ClusterConfigurationInfo
currentVersion string: The current version of the MSK cluster
encryptionInfo ClusterEncryptionInfo
enhancedMonitoring ClusterEnhancedMonitoring
kafkaVersion string
loggingInfo ClusterLoggingInfo
numberOfBrokerNodes number
openMonitoring ClusterOpenMonitoring
storageMode ClusterStorageMode
tags {[key: string]: string}: A key-value pair to associate with a resource.

arn str
broker_node_group_info ClusterBrokerNodeGroupInfo
client_authentication ClusterClientAuthentication
configuration_info ClusterConfigurationInfo
current_version str: The current version of the MSK cluster
encryption_info ClusterEncryptionInfo
enhanced_monitoring ClusterEnhancedMonitoring
kafka_version str
logging_info ClusterLoggingInfo
number_of_broker_nodes int
open_monitoring ClusterOpenMonitoring
storage_mode ClusterStorageMode
tags Mapping[str, str]: A key-value pair to associate with a resource.

arn String
brokerNodeGroupInfo Property Map
clientAuthentication Property Map
configurationInfo Property Map
currentVersion String: The current version of the MSK cluster
encryptionInfo Property Map
enhancedMonitoring "DEFAULT" | "PER_BROKER" | "PER_TOPIC_PER_BROKER" | "PER_TOPIC_PER_PARTITION"
kafkaVersion String
loggingInfo Property Map
numberOfBrokerNodes Number
openMonitoring Property Map
storageMode "LOCAL" | "TIERED"
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>
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
ConnectivityInfo Pulumi.AwsNative.Msk.Inputs.ClusterConnectivityInfo
SecurityGroups List<string>
StorageInfo Pulumi.AwsNative.Msk.Inputs.ClusterStorageInfo

ClientSubnets []string
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
ConnectivityInfo ClusterConnectivityInfo
SecurityGroups []string
StorageInfo ClusterStorageInfo

clientSubnets List<String>
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
connectivityInfo ClusterConnectivityInfo
securityGroups List<String>
storageInfo ClusterStorageInfo

clientSubnets string[]
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
connectivityInfo ClusterConnectivityInfo
securityGroups string[]
storageInfo ClusterStorageInfo

client_subnets Sequence[str]
instance_type str: 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.
broker_az_distribution str
connectivity_info ClusterConnectivityInfo
security_groups Sequence[str]
storage_info ClusterStorageInfo

clientSubnets List<String>
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
connectivityInfo Property Map
securityGroups List<String>
storageInfo Property Map