kafka_versions

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

Overview

Name	kafka_versions
Type	Resource
Id	aws.kafka.kafka_versions

Fields

The following fields are returned by SELECT queries:

list_kafka_versions

Name	Datatype	Description
status	string	(ACTIVE, DEPRECATED)
version	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_kafka_versions	select	region	maxResults, nextToken	Returns a list of Apache Kafka versions.
update_cluster_kafka_version	update	cluster_arn, region, CurrentVersion, TargetKafkaVersion		Updates the Apache Kafka version for 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) of the cluster to be updated.
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_kafka_versions

Returns a list of Apache Kafka versions.

SELECT
status,
version
FROM aws.kafka.kafka_versions
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

update_cluster_kafka_version

Updates the Apache Kafka version for the cluster.

UPDATE aws.kafka.kafka_versions
SET 
ConfigurationInfo = '{{ ConfigurationInfo }}',
CurrentVersion = '{{ CurrentVersion }}',
TargetKafkaVersion = '{{ TargetKafkaVersion }}'
WHERE 
cluster_arn = '{{ cluster_arn }}' --required
AND region = '{{ region }}' --required
AND CurrentVersion = '{{ CurrentVersion }}' --required
AND TargetKafkaVersion = '{{ TargetKafkaVersion }}' --required
RETURNING
cluster_arn,
cluster_operation_arn;