Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.
Parameters:
-
cluster_name
(String)
–
The name of the cluster to be deleted.
Raises:
Source code in docs_src/capo_dax/_services/async_dax.py
| async def delete_cluster(
self,
cluster_name: "capo_dax.types.string.String",
*,
config_overrides: Optional[AsyncDAXClientConfig] = None,
) -> "capo_dax.types.delete_cluster_response.DeleteClusterResponse":
"""<p>Deletes a previously provisioned DAX cluster. <i>DeleteCluster</i> deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.</p>
Args:
cluster_name: <p>The name of the cluster to be deleted.</p>
Raises:
capo_dax.errors.cluster_not_found_fault.ClusterNotFoundFault: <p>The requested cluster ID does not refer to an existing DAX cluster.</p>
capo_dax.errors.invalid_cluster_state_fault.InvalidClusterStateFault: <p>The requested DAX cluster is not in the <i>available</i> state.</p>
capo_dax.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
capo_dax.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
capo_dax.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The specified service linked role (SLR) was not found.</p>
capo_dax.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_dax.types.delete_cluster_request.DeleteClusterRequest]",
) -> AsyncOperationResponse[
"capo_dax.types.delete_cluster_response.DeleteClusterResponse"
]:
import capo_dax._operations.amazon_daxv3.delete_cluster
(
output,
http_response,
) = await capo_dax._operations.amazon_daxv3.delete_cluster.async_delete_cluster(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteCluster")
)
input_: capo_dax.types.delete_cluster_request.DeleteClusterRequest = {
"cluster_name": cluster_name
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|