Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. msk
  5. getBootstrapBrokers
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.msk.getBootstrapBrokers

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Get a list of brokers that a client application can use to bootstrap.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.msk.getBootstrapBrokers({
    clusterArn: exampleAwsMskCluster.arn,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.msk.get_bootstrap_brokers(cluster_arn=example_aws_msk_cluster["arn"])
Copy
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.GetBootstrapBrokers(ctx, &msk.GetBootstrapBrokersArgs{
			ClusterArn: exampleAwsMskCluster.Arn,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Msk.GetBootstrapBrokers.Invoke(new()
    {
        ClusterArn = exampleAwsMskCluster.Arn,
    });

});
Copy
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.GetBootstrapBrokersArgs;
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.getBootstrapBrokers(GetBootstrapBrokersArgs.builder()
            .clusterArn(exampleAwsMskCluster.arn())
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:msk:getBootstrapBrokers
      arguments:
        clusterArn: ${exampleAwsMskCluster.arn}
Copy

Using getBootstrapBrokers

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 getBootstrapBrokers(args: GetBootstrapBrokersArgs, opts?: InvokeOptions): Promise<GetBootstrapBrokersResult>
function getBootstrapBrokersOutput(args: GetBootstrapBrokersOutputArgs, opts?: InvokeOptions): Output<GetBootstrapBrokersResult>
Copy
def get_bootstrap_brokers(cluster_arn: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetBootstrapBrokersResult
def get_bootstrap_brokers_output(cluster_arn: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetBootstrapBrokersResult]
Copy
func GetBootstrapBrokers(ctx *Context, args *GetBootstrapBrokersArgs, opts ...InvokeOption) (*GetBootstrapBrokersResult, error)
func GetBootstrapBrokersOutput(ctx *Context, args *GetBootstrapBrokersOutputArgs, opts ...InvokeOption) GetBootstrapBrokersResultOutput
Copy

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

public static class GetBootstrapBrokers 
{
    public static Task<GetBootstrapBrokersResult> InvokeAsync(GetBootstrapBrokersArgs args, InvokeOptions? opts = null)
    public static Output<GetBootstrapBrokersResult> Invoke(GetBootstrapBrokersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBootstrapBrokersResult> getBootstrapBrokers(GetBootstrapBrokersArgs args, InvokeOptions options)
public static Output<GetBootstrapBrokersResult> getBootstrapBrokers(GetBootstrapBrokersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:msk/getBootstrapBrokers:getBootstrapBrokers
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterArn This property is required. string
ARN of the cluster the nodes belong to.
ClusterArn This property is required. string
ARN of the cluster the nodes belong to.
clusterArn This property is required. String
ARN of the cluster the nodes belong to.
clusterArn This property is required. string
ARN of the cluster the nodes belong to.
cluster_arn This property is required. str
ARN of the cluster the nodes belong to.
clusterArn This property is required. String
ARN of the cluster the nodes belong to.

getBootstrapBrokers Result

The following output properties are available:

BootstrapBrokers string
Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster.
BootstrapBrokersPublicSaslIam string
One or more DNS names (or IP addresses) and SASL IAM port pairs.
BootstrapBrokersPublicSaslScram string
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
BootstrapBrokersPublicTls string
One or more DNS names (or IP addresses) and TLS port pairs.
BootstrapBrokersSaslIam string
One or more DNS names (or IP addresses) and SASL IAM port pairs.
BootstrapBrokersSaslScram string
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
BootstrapBrokersTls string
One or more DNS names (or IP addresses) and TLS port pairs.
BootstrapBrokersVpcConnectivitySaslIam string
A string containing one or more DNS names (or IP addresses) and SASL IAM port pairs for VPC connectivity.
BootstrapBrokersVpcConnectivitySaslScram string
A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity.
BootstrapBrokersVpcConnectivityTls string
A string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity.
ClusterArn string
Id string
The provider-assigned unique ID for this managed resource.
BootstrapBrokers string
Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster.
BootstrapBrokersPublicSaslIam string
One or more DNS names (or IP addresses) and SASL IAM port pairs.
BootstrapBrokersPublicSaslScram string
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
BootstrapBrokersPublicTls string
One or more DNS names (or IP addresses) and TLS port pairs.
BootstrapBrokersSaslIam string
One or more DNS names (or IP addresses) and SASL IAM port pairs.
BootstrapBrokersSaslScram string
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
BootstrapBrokersTls string
One or more DNS names (or IP addresses) and TLS port pairs.
BootstrapBrokersVpcConnectivitySaslIam string
A string containing one or more DNS names (or IP addresses) and SASL IAM port pairs for VPC connectivity.
BootstrapBrokersVpcConnectivitySaslScram string
A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity.
BootstrapBrokersVpcConnectivityTls string
A string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity.
ClusterArn string
Id string
The provider-assigned unique ID for this managed resource.
bootstrapBrokers String
Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster.
bootstrapBrokersPublicSaslIam String
One or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrapBrokersPublicSaslScram String
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
bootstrapBrokersPublicTls String
One or more DNS names (or IP addresses) and TLS port pairs.
bootstrapBrokersSaslIam String
One or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrapBrokersSaslScram String
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
bootstrapBrokersTls String
One or more DNS names (or IP addresses) and TLS port pairs.
bootstrapBrokersVpcConnectivitySaslIam String
A string containing one or more DNS names (or IP addresses) and SASL IAM port pairs for VPC connectivity.
bootstrapBrokersVpcConnectivitySaslScram String
A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity.
bootstrapBrokersVpcConnectivityTls String
A string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity.
clusterArn String
id String
The provider-assigned unique ID for this managed resource.
bootstrapBrokers string
Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster.
bootstrapBrokersPublicSaslIam string
One or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrapBrokersPublicSaslScram string
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
bootstrapBrokersPublicTls string
One or more DNS names (or IP addresses) and TLS port pairs.
bootstrapBrokersSaslIam string
One or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrapBrokersSaslScram string
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
bootstrapBrokersTls string
One or more DNS names (or IP addresses) and TLS port pairs.
bootstrapBrokersVpcConnectivitySaslIam string
A string containing one or more DNS names (or IP addresses) and SASL IAM port pairs for VPC connectivity.
bootstrapBrokersVpcConnectivitySaslScram string
A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity.
bootstrapBrokersVpcConnectivityTls string
A string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity.
clusterArn string
id string
The provider-assigned unique ID for this managed resource.
bootstrap_brokers str
Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster.
bootstrap_brokers_public_sasl_iam str
One or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrap_brokers_public_sasl_scram str
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
bootstrap_brokers_public_tls str
One or more DNS names (or IP addresses) and TLS port pairs.
bootstrap_brokers_sasl_iam str
One or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrap_brokers_sasl_scram str
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
bootstrap_brokers_tls str
One or more DNS names (or IP addresses) and TLS port pairs.
bootstrap_brokers_vpc_connectivity_sasl_iam str
A string containing one or more DNS names (or IP addresses) and SASL IAM port pairs for VPC connectivity.
bootstrap_brokers_vpc_connectivity_sasl_scram str
A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity.
bootstrap_brokers_vpc_connectivity_tls str
A string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity.
cluster_arn str
id str
The provider-assigned unique ID for this managed resource.
bootstrapBrokers String
Comma separated list of one or more hostname:port pairs of kafka brokers suitable to bootstrap connectivity to the kafka cluster.
bootstrapBrokersPublicSaslIam String
One or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrapBrokersPublicSaslScram String
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
bootstrapBrokersPublicTls String
One or more DNS names (or IP addresses) and TLS port pairs.
bootstrapBrokersSaslIam String
One or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrapBrokersSaslScram String
One or more DNS names (or IP addresses) and SASL SCRAM port pairs.
bootstrapBrokersTls String
One or more DNS names (or IP addresses) and TLS port pairs.
bootstrapBrokersVpcConnectivitySaslIam String
A string containing one or more DNS names (or IP addresses) and SASL IAM port pairs for VPC connectivity.
bootstrapBrokersVpcConnectivitySaslScram String
A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity.
bootstrapBrokersVpcConnectivityTls String
A string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity.
clusterArn String
id String
The provider-assigned unique ID for this managed resource.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws