BootstrapBrokers - Amazon Managed Streaming for Apache Kafka
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

BootstrapBrokers

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

URI

/v1/clusters/clusterArn/bootstrap-brokers

HTTP methods

GET

Operation ID: GetBootstrapBrokers

A list of brokers that a client can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the ARN of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters operation to get the ARNs of all the clusters in this account and Region.

import boto3 client = boto3.client('kafka') response = client.get_bootstrap_brokers( ClusterArn='arn:aws:kafka:us-east-1:0123456789019:cluster/SalesCluster/abcd1234-abcd-cafe-abab-9876543210ab-4', ) print(response['BootstrapBrokerString'])
Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status codeResponse modelDescription
200 GetBootstrapBrokersResponse

Successful response.

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

503 response

OPTIONS

Enable CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Response bodies

{ "message": "string", "invalidParameter": "string" }

Properties

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

GetBootstrapBrokersResponse

Returns a string containing one or more hostname:port pairs.

PropertyTypeRequiredDescription
bootstrapBrokerString

string

False

A string containing one or more hostname:port pairs.

bootstrapBrokerStringPublicSaslIam

string

False

A string that is one or more pairs of DNS names (or IP addresses) and SASL IAM ports for public access.

bootstrapBrokerStringPublicSaslScram

string

False

A string that is one or more pairs of DNS names (or IP addresses) and SASL IAM ports for public access.

bootstrapBrokerStringPublicTls

string

False

A string that is one or more pairs of DNS names (or IP addresses) and SASL IAM ports for public access.

bootstrapBrokerStringSaslIam

string

False

A string containing one or more dns name (or IP) and SASL IAM port pairs.

bootstrapBrokerStringSaslScram

string

False

A string containing one or more dns name (or IP) and SASL SCRAM port pairs.

bootstrapBrokerStringTls

string

False

A string containing one or more DNS names (or IP) and TLS port pairs. The following is an example.

{ "BootstrapBrokerStringTls": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094" }