cancelUpdate method
Cancels an in-progress update to an Amazon EKS cluster on a best-effort
basis. Cancellation is only performed if the update can be cancelled.
Currently, this is supported for VersionRollback update types
on EKS Auto Mode clusters when nodes are rolling back.
A successful cancellation stops the node rollback. After cancellation, nodes converge to the current cluster version honoring configured disruption controls. If the control plane rollback has already begun, the cancellation request fails.
May throw ClientException.
May throw InvalidParameterException.
May throw InvalidRequestException.
May throw InvalidStateException.
May throw ResourceInUseException.
May throw ResourceNotFoundException.
May throw ServerException.
May throw ThrottlingException.
Parameter name :
The name of the Amazon EKS cluster associated with the update.
Parameter updateId :
The ID of the update to cancel.
Parameter clientRequestToken :
A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
Implementation
Future<CancelUpdateResponse> cancelUpdate({
required String name,
required String updateId,
String? clientRequestToken,
}) async {
final $payload = <String, dynamic>{
'clientRequestToken': clientRequestToken ?? _s.generateIdempotencyToken(),
};
final response = await _protocol.send(
payload: $payload,
method: 'POST',
requestUri:
'/clusters/${Uri.encodeComponent(name)}/updates/${Uri.encodeComponent(updateId)}/cancel-update',
exceptionFnMap: _exceptionFns,
);
return CancelUpdateResponse.fromJson(response);
}