Skip to content

delete_multi_region_cluster

delete_multi_region_cluster(
    multi_region_cluster_name: String,
    *,
    config_overrides: Optional[MemoryDBClientConfig] = None,
) -> DeleteMultiRegionClusterResponse

Deletes an existing multi-Region cluster.

Parameters:

  • multi_region_cluster_name (String) –

    The name of the multi-Region cluster to be deleted.

Raises:

Source code in docs_src/capo_memorydb/_services/memory_db.py
def delete_multi_region_cluster(
    self,
    multi_region_cluster_name: "capo_memorydb.types.string.String",
    *,
    config_overrides: Optional[MemoryDBClientConfig] = None,
) -> "capo_memorydb.types.delete_multi_region_cluster_response.DeleteMultiRegionClusterResponse":
    """<p>Deletes an existing multi-Region cluster.</p>

    Args:
        multi_region_cluster_name: <p>The name of the multi-Region cluster to be deleted.</p>

    Raises:
        capo_memorydb.errors.invalid_multi_region_cluster_state_fault.InvalidMultiRegionClusterStateFault: <p>The requested operation cannot be performed on the multi-Region cluster in its current state.</p>
        capo_memorydb.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The specified parameter value is not valid.</p>
        capo_memorydb.errors.multi_region_cluster_not_found_fault.MultiRegionClusterNotFoundFault: <p>The specified multi-Region cluster does not exist.</p>
        capo_memorydb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_memorydb.types.delete_multi_region_cluster_request.DeleteMultiRegionClusterRequest]",
    ) -> OperationResponse[
        "capo_memorydb.types.delete_multi_region_cluster_response.DeleteMultiRegionClusterResponse"
    ]:
        import capo_memorydb._operations.amazon_memory_db.delete_multi_region_cluster

        output, http_response = (
            capo_memorydb._operations.amazon_memory_db.delete_multi_region_cluster.delete_multi_region_cluster(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteMultiRegionCluster")
    )
    input_: capo_memorydb.types.delete_multi_region_cluster_request.DeleteMultiRegionClusterRequest = {
        "multi_region_cluster_name": multi_region_cluster_name
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output