cluster_operations

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

Overview

Name	cluster_operations
Type	Resource
Id	aws.kafka.cluster_operations

Fields

The following fields are returned by SELECT queries:

describe_cluster_operation

Name	Datatype	Description
client_request_id	string	The ID of the API request that triggered this operation.
cluster_arn	string	ARN of the cluster.
creation_time	string (date-time)	The time that the operation was created.
end_time	string (date-time)	The time at which the operation finished.
error_info	object	Describes the error if the operation fails.
operation_arn	string	ARN of the cluster operation.
operation_state	string	State of the cluster operation.
operation_steps	array	Steps completed during the operation.
operation_type	string	Type of the cluster operation.
source_cluster_info	object	Information about cluster attributes before a cluster is updated.
target_cluster_info	object	Information about cluster attributes after a cluster is updated.
vpc_connection_info	object	Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

list_cluster_operations

Name	Datatype	Description
client_request_id	string	The ID of the API request that triggered this operation.
cluster_arn	string	ARN of the cluster.
creation_time	string (date-time)	The time that the operation was created.
end_time	string (date-time)	The time at which the operation finished.
error_info	object	Describes the error if the operation fails.
operation_arn	string	ARN of the cluster operation.
operation_state	string	State of the cluster operation.
operation_steps	array	Steps completed during the operation.
operation_type	string	Type of the cluster operation.
source_cluster_info	object	Information about cluster attributes before a cluster is updated.
target_cluster_info	object	Information about cluster attributes after a cluster is updated.
vpc_connection_info	object	Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cluster_operation	select	cluster_operation_arn, region		Returns a description of the cluster operation specified by the ARN.
list_cluster_operations	select	cluster_arn, region	maxResults, nextToken	Returns a list of all the operations that have been performed on the specified 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.
cluster_operation_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
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

describe_cluster_operation

Returns a description of the cluster operation specified by the ARN.

SELECT
client_request_id,
cluster_arn,
creation_time,
end_time,
error_info,
operation_arn,
operation_state,
operation_steps,
operation_type,
source_cluster_info,
target_cluster_info,
vpc_connection_info
FROM aws.kafka.cluster_operations
WHERE cluster_operation_arn = '{{ cluster_operation_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_cluster_operations

Returns a list of all the operations that have been performed on the specified MSK cluster.

SELECT
client_request_id,
cluster_arn,
creation_time,
end_time,
error_info,
operation_arn,
operation_state,
operation_steps,
operation_type,
source_cluster_info,
target_cluster_info,
vpc_connection_info
FROM aws.kafka.cluster_operations
WHERE cluster_arn = '{{ cluster_arn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;