1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. msk
  6. getBrokerNodes
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi
aws logo aws logo
Viewing docs for AWS v7.52.1
published on Wednesday, Oct 28, 2026 by Pulumi

    Get information on an Amazon MSK Broker Nodes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.msk.getBrokerNodes({
        clusterArn: exampleAwsMskCluster.arn,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.msk.get_broker_nodes(cluster_arn=example_aws_msk_cluster["arn"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/msk"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := msk.GetBrokerNodes(ctx, &msk.GetBrokerNodesArgs{
    			ClusterArn: exampleAwsMskCluster.Arn,
    		}, 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.GetBrokerNodes.Invoke(new()
        {
            ClusterArn = exampleAwsMskCluster.Arn,
        });
    
    });
    
    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.GetBrokerNodesArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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.getBrokerNodes(GetBrokerNodesArgs.builder()
                .clusterArn(exampleAwsMskCluster.get("arn"))
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aws:msk:getBrokerNodes
          arguments:
            clusterArn: ${exampleAwsMskCluster.arn}
    
    terraform {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    data "aws_msk_broker_nodes" "example" {
      cluster_arn = exampleAwsMskCluster.arn
    }
    

    Using getBrokerNodes

    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 getBrokerNodes(args: GetBrokerNodesArgs, opts?: InvokeOptions): Promise<GetBrokerNodesResult>
    function getBrokerNodesOutput(args: GetBrokerNodesOutputArgs, opts?: InvokeOutputOptions): Output<GetBrokerNodesResult>
    def get_broker_nodes(cluster_arn: Optional[str] = None,
                         region: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetBrokerNodesResult
    def get_broker_nodes_output(cluster_arn: pulumi.Input[Optional[str]] = None,
                         region: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetBrokerNodesResult]
    func GetBrokerNodes(ctx *Context, args *GetBrokerNodesArgs, opts ...InvokeOption) (*GetBrokerNodesResult, error)
    func GetBrokerNodesOutput(ctx *Context, args *GetBrokerNodesOutputArgs, opts ...InvokeOption) GetBrokerNodesResultOutput

    > Note: This function is named GetBrokerNodes in the Go SDK.

    public static class GetBrokerNodes 
    {
        public static Task<GetBrokerNodesResult> InvokeAsync(GetBrokerNodesArgs args, InvokeOptions? opts = null)
        public static Output<GetBrokerNodesResult> Invoke(GetBrokerNodesInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetBrokerNodesResult> Invoke(GetBrokerNodesInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetBrokerNodesResult> getBrokerNodes(GetBrokerNodesArgs args, InvokeOptions options)
    public static Output<GetBrokerNodesResult> getBrokerNodes(GetBrokerNodesArgs args, InvokeOptions options)
    public static Output<GetBrokerNodesResult> getBrokerNodes(GetBrokerNodesArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: aws:msk/getBrokerNodes:getBrokerNodes
      arguments:
        # arguments dictionary
    data "aws_msk_get_broker_nodes" "name" {
        # arguments
    }

    The following arguments are supported:

    ClusterArn string
    ARN of the cluster the nodes belong to.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    ClusterArn string
    ARN of the cluster the nodes belong to.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    cluster_arn string
    ARN of the cluster the nodes belong to.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    clusterArn String
    ARN of the cluster the nodes belong to.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    clusterArn string
    ARN of the cluster the nodes belong to.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    cluster_arn str
    ARN of the cluster the nodes belong to.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    clusterArn String
    ARN of the cluster the nodes belong to.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    getBrokerNodes Result

    The following output properties are available:

    ClusterArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeInfoLists List<GetBrokerNodesNodeInfoList>
    List of MSK Broker Nodes, sorted by broker ID in ascending order. See nodeInfoList Block for details.
    Region string
    ClusterArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    NodeInfoLists []GetBrokerNodesNodeInfoList
    List of MSK Broker Nodes, sorted by broker ID in ascending order. See nodeInfoList Block for details.
    Region string
    cluster_arn string
    id string
    The provider-assigned unique ID for this managed resource.
    node_info_lists list(object)
    List of MSK Broker Nodes, sorted by broker ID in ascending order. See nodeInfoList Block for details.
    region string
    clusterArn String
    id String
    The provider-assigned unique ID for this managed resource.
    nodeInfoLists List<GetBrokerNodesNodeInfoList>
    List of MSK Broker Nodes, sorted by broker ID in ascending order. See nodeInfoList Block for details.
    region String
    clusterArn string
    id string
    The provider-assigned unique ID for this managed resource.
    nodeInfoLists GetBrokerNodesNodeInfoList[]
    List of MSK Broker Nodes, sorted by broker ID in ascending order. See nodeInfoList Block for details.
    region string
    cluster_arn str
    id str
    The provider-assigned unique ID for this managed resource.
    node_info_lists Sequence[GetBrokerNodesNodeInfoList]
    List of MSK Broker Nodes, sorted by broker ID in ascending order. See nodeInfoList Block for details.
    region str
    clusterArn String
    id String
    The provider-assigned unique ID for this managed resource.
    nodeInfoLists List<Property Map>
    List of MSK Broker Nodes, sorted by broker ID in ascending order. See nodeInfoList Block for details.
    region String

    Supporting Types

    GetBrokerNodesNodeInfoList

    AttachedEniId string
    Attached elastic network interface of the broker.
    BrokerId double
    ID of the broker.
    ClientSubnet string
    Client subnet to which this broker node belongs.
    ClientVpcIpAddress string
    Client VPC IP address.
    Endpoints List<string>
    Set of endpoints for accessing the broker. This does not include ports.
    NodeArn string
    ARN of the node.
    AttachedEniId string
    Attached elastic network interface of the broker.
    BrokerId float64
    ID of the broker.
    ClientSubnet string
    Client subnet to which this broker node belongs.
    ClientVpcIpAddress string
    Client VPC IP address.
    Endpoints []string
    Set of endpoints for accessing the broker. This does not include ports.
    NodeArn string
    ARN of the node.
    attached_eni_id string
    Attached elastic network interface of the broker.
    broker_id number
    ID of the broker.
    client_subnet string
    Client subnet to which this broker node belongs.
    client_vpc_ip_address string
    Client VPC IP address.
    endpoints list(string)
    Set of endpoints for accessing the broker. This does not include ports.
    node_arn string
    ARN of the node.
    attachedEniId String
    Attached elastic network interface of the broker.
    brokerId Double
    ID of the broker.
    clientSubnet String
    Client subnet to which this broker node belongs.
    clientVpcIpAddress String
    Client VPC IP address.
    endpoints List<String>
    Set of endpoints for accessing the broker. This does not include ports.
    nodeArn String
    ARN of the node.
    attachedEniId string
    Attached elastic network interface of the broker.
    brokerId number
    ID of the broker.
    clientSubnet string
    Client subnet to which this broker node belongs.
    clientVpcIpAddress string
    Client VPC IP address.
    endpoints string[]
    Set of endpoints for accessing the broker. This does not include ports.
    nodeArn string
    ARN of the node.
    attached_eni_id str
    Attached elastic network interface of the broker.
    broker_id float
    ID of the broker.
    client_subnet str
    Client subnet to which this broker node belongs.
    client_vpc_ip_address str
    Client VPC IP address.
    endpoints Sequence[str]
    Set of endpoints for accessing the broker. This does not include ports.
    node_arn str
    ARN of the node.
    attachedEniId String
    Attached elastic network interface of the broker.
    brokerId Number
    ID of the broker.
    clientSubnet String
    Client subnet to which this broker node belongs.
    clientVpcIpAddress String
    Client VPC IP address.
    endpoints List<String>
    Set of endpoints for accessing the broker. This does not include ports.
    nodeArn String
    ARN of the node.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.52.1
    published on Wednesday, Oct 28, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial