bootstrap_brokers

Creates, updates, deletes, gets or lists a bootstrap_brokers resource.

Overview

Name	bootstrap_brokers
Type	Resource
Id	aws.kafka.bootstrap_brokers

Fields

The following fields are returned by SELECT queries:

get_bootstrap_brokers

Name	Datatype	Description
bootstrap_broker_string	string	A string containing one or more hostname:port pairs.
bootstrap_broker_string_ipv_6	string	A string that contains one or more DNS names (or IP) and port pairs for IPv6 connectivity.
bootstrap_broker_string_public_sasl_iam	string	A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrap_broker_string_public_sasl_scram	string	A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
bootstrap_broker_string_public_tls	string	A string containing one or more DNS names (or IP) and TLS port pairs.
bootstrap_broker_string_sasl_iam	string	A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.
bootstrap_broker_string_sasl_iam_ipv_6	string	A string that contains one or more DNS names (or IP) and SASL IAM port pairs for IPv6 connectivity.
bootstrap_broker_string_sasl_scram	string	A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
bootstrap_broker_string_sasl_scram_ipv_6	string	A string that contains one or more DNS names (or IP) and SASL SCRAM port pairs for IPv6 connectivity.
bootstrap_broker_string_tls	string	A string containing one or more DNS names (or IP) and TLS port pairs.
bootstrap_broker_string_tls_ipv_6	string	A string that contains one or more DNS names (or IP) and TLS port pairs for IPv6 connectivity.
bootstrap_broker_string_vpc_connectivity_sasl_iam	string	A string containing one or more DNS names (or IP) and SASL/IAM port pairs for VPC connectivity.
bootstrap_broker_string_vpc_connectivity_sasl_scram	string	A string containing one or more DNS names (or IP) and SASL/SCRAM port pairs for VPC connectivity.
bootstrap_broker_string_vpc_connectivity_tls	string	A string containing one or more DNS names (or IP) and TLS port pairs for VPC connectivity.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bootstrap_brokers	select	cluster_arn, region		A list of brokers that a client application 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 Amazon Resource Name (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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the cluster.
region	string	AWS region (default: us-east-1)

SELECT examples

get_bootstrap_brokers

A list of brokers that a client application 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 Amazon Resource Name (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.

SELECT
bootstrap_broker_string,
bootstrap_broker_string_ipv_6,
bootstrap_broker_string_public_sasl_iam,
bootstrap_broker_string_public_sasl_scram,
bootstrap_broker_string_public_tls,
bootstrap_broker_string_sasl_iam,
bootstrap_broker_string_sasl_iam_ipv_6,
bootstrap_broker_string_sasl_scram,
bootstrap_broker_string_sasl_scram_ipv_6,
bootstrap_broker_string_tls,
bootstrap_broker_string_tls_ipv_6,
bootstrap_broker_string_vpc_connectivity_sasl_iam,
bootstrap_broker_string_vpc_connectivity_sasl_scram,
bootstrap_broker_string_vpc_connectivity_tls
FROM aws.kafka.bootstrap_brokers
WHERE cluster_arn = '{{ cluster_arn }}' -- required
AND region = '{{ region }}' -- required
;