BootstrapBrokers - Amazon Managed Streaming for Apache Kafka

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 application can use to bootstrap. 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
Name Type Required Description
clusterArn String True

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

Responses
Status Code Response Model Description
200 GetBootstrapBrokersResponse

Successful response.

400 Error

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

401 Error

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

403 Error

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

404 Error

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

429 Error

429 response

500 Error

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

503 Error

503 response

Schemas

Response Bodies

Example GetBootstrapBrokersResponse

{ "bootstrapBrokerString": "string", "bootstrapBrokerStringSaslScram": "string", "bootstrapBrokerStringTls": "string" }

Example Error

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

Properties

Error

Returns information about an error.

Property Type Required Description
message

string

False

The description of the error.

invalidParameter

string

False

The parameter that caused the error.

GetBootstrapBrokersResponse

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

Property Type Required Description
bootstrapBrokerString

string

False

A string containing one or more hostname: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" }

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetBootstrapBrokers