cluster_operation_v2s
Creates, updates, deletes, gets or lists a cluster_operation_v2s resource.
Overview
| Name | cluster_operation_v2s |
| Type | Resource |
| Id | aws.kafka.cluster_operation_v2s |
Fields
The following fields are returned by SELECT queries:
- describe_cluster_operation_v2
| Name | Datatype | Description |
|---|---|---|
cluster_arn | string | ARN of the cluster. |
cluster_type | string | Type of the backend cluster. (PROVISIONED, SERVERLESS) |
end_time | string (date-time) | The time at which the operation finished. |
error_info | object | If cluster operation failed from an error, it describes the error. |
operation_arn | string | ARN of the cluster operation. |
operation_state | string | State of the cluster operation. |
operation_type | string | Type of the cluster operation. |
provisioned | object | Properties of a provisioned cluster. |
serverless | object | Properties of a serverless cluster. |
start_time | string (date-time) | The time at which operation was started. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_cluster_operation_v2 | select | cluster_operation_arn, region | Returns a description of the cluster operation specified by the ARN. |
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_operation_arn | string | ARN of the cluster operation to describe. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_cluster_operation_v2
Returns a description of the cluster operation specified by the ARN.
SELECT
cluster_arn,
cluster_type,
end_time,
error_info,
operation_arn,
operation_state,
operation_type,
provisioned,
serverless,
start_time
FROM aws.kafka.cluster_operation_v2s
WHERE cluster_operation_arn = '{{ cluster_operation_arn }}' -- required
AND region = '{{ region }}' -- required
;