topic_partitions

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

Overview

Name	topic_partitions
Type	Resource
Id	aws.kafka.topic_partitions

Fields

The following fields are returned by SELECT queries:

describe_topic_partitions

Name	Datatype	Description
isr	array	The list of in-sync replica broker IDs for the partition.
leader	integer	The leader broker ID for the partition.
partition	integer	The partition ID.
replicas	array	The list of replica broker IDs for the partition.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_topic_partitions	select	cluster_arn, topic_name, region	maxResults, nextToken	Returns partition details of this topic on a MSK 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)
topic_name	string	The Kafka topic name that uniquely identifies the topic.
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

describe_topic_partitions

Returns partition details of this topic on a MSK cluster.

SELECT
isr,
leader,
partition,
replicas
FROM aws.kafka.topic_partitions
WHERE cluster_arn = '{{ cluster_arn }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;