nodes

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

Overview

Name	nodes
Type	Resource
Id	aws.kafka.nodes

Fields

The following fields are returned by SELECT queries:

list_nodes

Name	Datatype	Description
added_to_cluster_time	string	The start time.
broker_node_info	object	The broker node info.
controller_node_info	object	The ControllerNodeInfo.
instance_type	string	The instance type.
node_arn	string	The Amazon Resource Name (ARN) of the node.
node_type	string	The node type. (BROKER)
zookeeper_node_info	object	The ZookeeperNodeInfo.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_nodes	select	cluster_arn, region	maxResults, nextToken	Returns a list of the broker nodes in the cluster.

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)
maxResults	integer	The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
nextToken	string	The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

SELECT examples

list_nodes

Returns a list of the broker nodes in the cluster.

SELECT
added_to_cluster_time,
broker_node_info,
controller_node_info,
instance_type,
node_arn,
node_type,
zookeeper_node_info
FROM aws.kafka.nodes
WHERE cluster_arn = '{{ cluster_arn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;