clusters_v2s

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

Overview

Name	clusters_v2s
Type	Resource
Id	aws.kafka.clusters_v2s

Fields

The following fields are returned by SELECT queries:

list_clusters_v2

Name	Datatype	Description
active_operation_arn	string	The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
cluster_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the cluster.
cluster_name	string	The name of the cluster.
cluster_type	string	Cluster Type. (PROVISIONED, SERVERLESS)
creation_time	string (date-time)	The time when the cluster was created.
current_version	string	The current version of the MSK cluster.
provisioned	object	Information about the provisioned cluster.
serverless	object	Information about the serverless cluster.
state	string	The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING. (ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, UPDATING)
state_info	object	State Info for the Amazon MSK cluster.
tags	object	Tags attached to the cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_clusters_v2	select	region	clusterNameFilter, clusterTypeFilter, maxResults, nextToken	Returns a list of all the MSK clusters in the current 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
region	string	AWS region (default: us-east-1)
clusterNameFilter	string	Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
clusterTypeFilter	string	Specify either PROVISIONED or SERVERLESS.
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_clusters_v2

Returns a list of all the MSK clusters in the current Region.

SELECT
active_operation_arn,
cluster_arn,
cluster_name,
cluster_type,
creation_time,
current_version,
provisioned,
serverless,
state,
state_info,
tags
FROM aws.kafka.clusters_v2s
WHERE region = '{{ region }}' -- required
AND clusterNameFilter = '{{ clusterNameFilter }}'
AND clusterTypeFilter = '{{ clusterTypeFilter }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;