get-bootstrap-brokers¶

Description¶

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

Synopsis¶

  get-bootstrap-brokers
--cluster-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--cluster-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To get bootstrap brokers

The following get-bootstrap-brokers example retrieves the bootstrap broker information for an Amazon MSK cluster.

aws kafka get-bootstrap-brokers \
    --cluster-arn arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5

Output:

{
    "BootstrapBrokerString": "b-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9092,b-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9092",
    "BootstrapBrokerStringTls": "b-1.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9094,b-2.demo-cluster-1.xuy0sb.c5.kafka.us-east-1.amazonaws.com:9094"
}

For more information, see Getting the Bootstrap Brokers in the Amazon Managed Streaming for Apache Kafka Developer Guide.

Output¶

BootstrapBrokerString -> (string)

A string containing one or more hostname:port pairs.

BootstrapBrokerStringTls -> (string)

A string containing one or more DNS names (or IP) and TLS port pairs.

BootstrapBrokerStringSaslScram -> (string)

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

BootstrapBrokerStringSaslIam -> (string)

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

BootstrapBrokerStringPublicTls -> (string)

A string containing one or more DNS names (or IP) and TLS port pairs.

BootstrapBrokerStringPublicSaslScram -> (string)

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

BootstrapBrokerStringPublicSaslIam -> (string)