We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 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.0.1 published on Tuesday, Oct 1, 2024 by Pulumi
Resource Type definition for AWS::MSK::Cluster
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
- Broker
Node Pulumi.Group Info Aws Native. Msk. Outputs. Cluster Broker Node Group Info - Client
Authentication Pulumi.Aws Native. Msk. Outputs. Cluster Client Authentication - Configuration
Info Pulumi.Aws Native. Msk. Outputs. Cluster Configuration Info - Current
Version string - The current version of the MSK cluster
- Encryption
Info Pulumi.Aws Native. Msk. Outputs. Cluster Encryption Info - Enhanced
Monitoring Pulumi.Aws Native. Msk. Cluster Enhanced Monitoring - Kafka
Version string - Logging
Info Pulumi.Aws Native. Msk. Outputs. Cluster Logging Info - Number
Of intBroker Nodes - Open
Monitoring Pulumi.Aws Native. Msk. Outputs. Cluster Open Monitoring - Storage
Mode Pulumi.Aws Native. Msk. Cluster Storage Mode - Dictionary<string, string>
- A key-value pair to associate with a resource.
- Arn string
- Broker
Node ClusterGroup Info Broker Node Group Info - Client
Authentication ClusterClient Authentication - Configuration
Info ClusterConfiguration Info - Current
Version string - The current version of the MSK cluster
- Encryption
Info ClusterEncryption Info - Enhanced
Monitoring ClusterEnhanced Monitoring - Kafka
Version string - Logging
Info ClusterLogging Info - Number
Of intBroker Nodes - Open
Monitoring ClusterOpen Monitoring - Storage
Mode ClusterStorage Mode - map[string]string
- A key-value pair to associate with a resource.
- arn String
- broker
Node ClusterGroup Info Broker Node Group Info - client
Authentication ClusterClient Authentication - configuration
Info ClusterConfiguration Info - current
Version String - The current version of the MSK cluster
- encryption
Info ClusterEncryption Info - enhanced
Monitoring ClusterEnhanced Monitoring - kafka
Version String - logging
Info ClusterLogging Info - number
Of IntegerBroker Nodes - open
Monitoring ClusterOpen Monitoring - storage
Mode ClusterStorage Mode - Map<String,String>
- A key-value pair to associate with a resource.
- arn string
- broker
Node ClusterGroup Info Broker Node Group Info - client
Authentication ClusterClient Authentication - configuration
Info ClusterConfiguration Info - current
Version string - The current version of the MSK cluster
- encryption
Info ClusterEncryption Info - enhanced
Monitoring ClusterEnhanced Monitoring - kafka
Version string - logging
Info ClusterLogging Info - number
Of numberBroker Nodes - open
Monitoring ClusterOpen Monitoring - storage
Mode ClusterStorage Mode - {[key: string]: string}
- A key-value pair to associate with a resource.
- arn str
- broker_
node_ Clustergroup_ info Broker Node Group Info - client_
authentication ClusterClient Authentication - configuration_
info ClusterConfiguration Info - current_
version str - The current version of the MSK cluster
- encryption_
info ClusterEncryption Info - enhanced_
monitoring ClusterEnhanced Monitoring - kafka_
version str - logging_
info ClusterLogging Info - number_
of_ intbroker_ nodes - open_
monitoring ClusterOpen Monitoring - storage_
mode ClusterStorage Mode - Mapping[str, str]
- A key-value pair to associate with a resource.
- arn String
- broker
Node Property MapGroup Info - client
Authentication Property Map - configuration
Info Property Map - current
Version String - The current version of the MSK cluster
- encryption
Info Property Map - enhanced
Monitoring "DEFAULT" | "PER_BROKER" | "PER_TOPIC_PER_BROKER" | "PER_TOPIC_PER_PARTITION" - kafka
Version String - logging
Info Property Map - number
Of NumberBroker Nodes - open
Monitoring Property Map - storage
Mode "LOCAL" | "TIERED" - Map<String>
- A key-value pair to associate with a resource.
Supporting Types
ClusterBrokerLogs
ClusterBrokerNodeGroupInfo
- Client
Subnets List<string> - Instance
Type 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.
- Broker
Az stringDistribution - Connectivity
Info Pulumi.Aws Native. Msk. Inputs. Cluster Connectivity Info - Security
Groups List<string> - Storage
Info Pulumi.Aws Native. Msk. Inputs. Cluster Storage Info
- Client
Subnets []string - Instance
Type 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.
- Broker
Az stringDistribution - Connectivity
Info ClusterConnectivity Info - Security
Groups []string - Storage
Info ClusterStorage Info
- client
Subnets List<String> - instance
Type 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.
- broker
Az StringDistribution - connectivity
Info ClusterConnectivity Info - security
Groups List<String> - storage
Info ClusterStorage Info
- client
Subnets string[] - instance
Type 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.
- broker
Az stringDistribution - connectivity
Info ClusterConnectivity Info - security
Groups string[] - storage
Info ClusterStorage Info
- 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_ strdistribution - connectivity_
info ClusterConnectivity Info - security_
groups Sequence[str] - storage_
info ClusterStorage Info
- client
Subnets List<String> - instance
Type 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.
- broker
Az StringDistribution - connectivity
Info Property Map - security
Groups List<String> - storage
Info Property Map
ClusterClientAuthentication
ClusterCloudWatchLogs
ClusterConfigurationInfo
ClusterConnectivityInfo
ClusterEbsStorageInfo
ClusterEncryptionAtRest
- Data
Volume stringKms Key Id
- Data
Volume stringKms Key Id
- data
Volume StringKms Key Id
- data
Volume stringKms Key Id
- data
Volume StringKms Key Id
ClusterEncryptionInTransit
ClusterEncryptionInTransitClientBroker
ClusterEncryptionInfo
ClusterEnhancedMonitoring
ClusterFirehose
- Enabled bool
- Delivery
Stream string
- Enabled bool
- Delivery
Stream string
- enabled Boolean
- delivery
Stream String
- enabled boolean
- delivery
Stream string
- enabled bool
- delivery_
stream str
- enabled Boolean
- delivery
Stream String
ClusterIam
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterJmxExporter
- Enabled
In boolBroker
- Enabled
In boolBroker
- enabled
In BooleanBroker
- enabled
In booleanBroker
- enabled_
in_ boolbroker
- enabled
In BooleanBroker
ClusterLoggingInfo
ClusterNodeExporter
- Enabled
In boolBroker
- Enabled
In boolBroker
- enabled
In BooleanBroker
- enabled
In booleanBroker
- enabled_
in_ boolbroker
- enabled
In BooleanBroker
ClusterOpenMonitoring
ClusterPrometheus
ClusterProvisionedThroughput
- Enabled bool
- Volume
Throughput int
- Enabled bool
- Volume
Throughput int
- enabled Boolean
- volume
Throughput Integer
- enabled boolean
- volume
Throughput number
- enabled bool
- volume_
throughput int
- enabled Boolean
- volume
Throughput Number
ClusterPublicAccess
- Type string
- Type string
- type String
- type string
- type str
- type String
ClusterS3
ClusterSasl
ClusterScram
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterStorageInfo
ClusterStorageMode
ClusterTls
- List<string>
- Enabled bool
- []string
- Enabled bool
- List<String>
- enabled Boolean
- string[]
- enabled boolean
- Sequence[str]
- enabled bool
- List<String>
- enabled Boolean
ClusterUnauthenticated
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterVpcConnectivity
ClusterVpcConnectivityClientAuthentication
ClusterVpcConnectivityIam
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterVpcConnectivitySasl
ClusterVpcConnectivityScram
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
ClusterVpcConnectivityTls
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi