1. Packages
  2. AWS Classic
  3. API Docs
  4. msk
  5. getBrokerNodes

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.4.0 published on Tuesday, Oct 3, 2023 by Pulumi

aws.msk.getBrokerNodes

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.4.0 published on Tuesday, Oct 3, 2023 by Pulumi

    Get information on an Amazon MSK Broker Nodes.

    Example Usage

    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 = aws_msk_cluster.Example.Arn,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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: aws_msk_cluster.Example.Arn,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.List;
    import java.util.ArrayList;
    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(aws_msk_cluster.example().arn())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.msk.get_broker_nodes(cluster_arn=aws_msk_cluster["example"]["arn"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.msk.getBrokerNodes({
        clusterArn: aws_msk_cluster.example.arn,
    });
    
    variables:
      example:
        fn::invoke:
          Function: aws:msk:getBrokerNodes
          Arguments:
            clusterArn: ${aws_msk_cluster.example.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?: InvokeOptions): Output<GetBrokerNodesResult>
    def get_broker_nodes(cluster_arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetBrokerNodesResult
    def get_broker_nodes_output(cluster_arn: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = 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 CompletableFuture<GetBrokerNodesResult> getBrokerNodes(GetBrokerNodesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:msk/getBrokerNodes:getBrokerNodes
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterArn string

    ARN of the cluster the nodes belong to.

    ClusterArn string

    ARN of the cluster the nodes belong to.

    clusterArn String

    ARN of the cluster the nodes belong to.

    clusterArn string

    ARN of the cluster the nodes belong to.

    cluster_arn str

    ARN of the cluster the nodes belong to.

    clusterArn String

    ARN of the cluster the nodes belong to.

    getBrokerNodes Result

    The following output properties are available:

    ClusterArn string
    Id string

    The provider-assigned unique ID for this managed resource.

    NodeInfoLists List<GetBrokerNodesNodeInfoList>
    ClusterArn string
    Id string

    The provider-assigned unique ID for this managed resource.

    NodeInfoLists []GetBrokerNodesNodeInfoList
    clusterArn String
    id String

    The provider-assigned unique ID for this managed resource.

    nodeInfoLists List<GetBrokerNodesNodeInfoList>
    clusterArn string
    id string

    The provider-assigned unique ID for this managed resource.

    nodeInfoLists GetBrokerNodesNodeInfoList[]
    cluster_arn str
    id str

    The provider-assigned unique ID for this managed resource.

    node_info_lists Sequence[GetBrokerNodesNodeInfoList]
    clusterArn String
    id String

    The provider-assigned unique ID for this managed resource.

    nodeInfoLists List<Property Map>

    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

    The client virtual private cloud (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

    The client virtual private cloud (VPC) IP address

    Endpoints []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 Double

    ID of the broker

    clientSubnet String

    Client subnet to which this broker node belongs

    clientVpcIpAddress String

    The client virtual private cloud (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

    The client virtual private cloud (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

    The client virtual private cloud (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

    The client virtual private cloud (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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.4.0 published on Tuesday, Oct 3, 2023 by Pulumi