← All packages

AWS Classic

Pulumi Official

Package maintained by Pulumi

v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

Source code

getBrokerNodes

Get information on an Amazon MSK Broker Nodes.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.Msk.GetBrokerNodes.InvokeAsync(new Aws.Msk.GetBrokerNodesArgs
        {
            ClusterArn = aws_msk_cluster.Example.Arn,
        }));
    }

}

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Output.of(MskFunctions.getBrokerNodes(GetBrokerNodesArgs.builder()
            .clusterArn(aws_msk_cluster.getExample().getArn())
            .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: The ARN of the cluster the nodes belong to.

ClusterArn string: The ARN of the cluster the nodes belong to.

clusterArn String: The ARN of the cluster the nodes belong to.

clusterArn string: The ARN of the cluster the nodes belong to.

cluster_arn str: The ARN of the cluster the nodes belong to.

clusterArn String: The 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<Pulumi.Aws.Msk.Outputs.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 ListBrokerNodesNodeInfoList>

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

Supporting Types

GetBrokerNodesNodeInfoList

AttachedEniId string: The attached elastic network interface of the broker
BrokerId double: The ID of the broker
ClientSubnet string: The 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: The Amazon Resource Name (ARN) of the node

AttachedEniId string: The attached elastic network interface of the broker
BrokerId float64: The ID of the broker
ClientSubnet string: The 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: The Amazon Resource Name (ARN) of the node

attachedEniId String: The attached elastic network interface of the broker
brokerId Double: The ID of the broker
clientSubnet String: The client subnet to which this broker node belongs
clientVpcIpAddress String: The client virtual private cloud (VPC) IP address
endpoints List: Set of endpoints for accessing the broker. This does not include ports
nodeArn String: The Amazon Resource Name (ARN) of the node

attachedEniId string: The attached elastic network interface of the broker
brokerId number: The ID of the broker
clientSubnet string: The 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: The Amazon Resource Name (ARN) of the node

attached_eni_id str: The attached elastic network interface of the broker
broker_id float: The ID of the broker
client_subnet str: The 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: The Amazon Resource Name (ARN) of the node

attachedEniId String: The attached elastic network interface of the broker
brokerId Number: The ID of the broker
clientSubnet String: The client subnet to which this broker node belongs
clientVpcIpAddress String: The client virtual private cloud (VPC) IP address
endpoints List: Set of endpoints for accessing the broker. This does not include ports
nodeArn String: The Amazon Resource Name (ARN) of the node

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.