1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. msk
  5. getCluster

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

aws-native logo

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:

    Supporting Types

    ClusterBrokerLogs

    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

    ClusterClientAuthentication

    ClusterCloudWatchLogs

    Enabled bool
    LogGroup string
    Enabled bool
    LogGroup string
    enabled Boolean
    logGroup String
    enabled boolean
    logGroup string
    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

    ClusterConnectivityInfo

    ClusterEbsStorageInfo

    ClusterEncryptionAtRest

    ClusterEncryptionInTransit

    ClusterEncryptionInTransitClientBroker

    ClusterEncryptionInfo

    ClusterEnhancedMonitoring

    ClusterFirehose

    enabled Boolean
    deliveryStream String
    enabled boolean
    deliveryStream string
    enabled Boolean
    deliveryStream String

    ClusterIam

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterJmxExporter

    ClusterLoggingInfo

    ClusterNodeExporter

    ClusterOpenMonitoring

    ClusterPrometheus

    ClusterProvisionedThroughput

    enabled Boolean
    volumeThroughput Integer

    ClusterPublicAccess

    Type string
    Type string
    type String
    type string
    type str
    type String

    ClusterS3

    Enabled bool
    Bucket string
    Prefix string
    Enabled bool
    Bucket string
    Prefix string
    enabled Boolean
    bucket String
    prefix String
    enabled boolean
    bucket string
    prefix string
    enabled bool
    bucket str
    prefix str
    enabled Boolean
    bucket String
    prefix String

    ClusterSasl

    ClusterScram

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterStorageInfo

    ClusterStorageMode

    ClusterTls

    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
    aws-native logo

    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