Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
Parameters:
-
db_cluster_parameter_group_name
(Optional[String], default:
None
)
–
The name of the cluster parameter group.
Constraints:
-
Must be the name of an existing cluster parameter group.
-
You can't delete a default cluster parameter group.
-
Cannot be associated with any clusters.
Raises:
Source code in docs_src/capo_docdb/_services/doc_db.py
| def delete_db_cluster_parameter_group(
self,
*,
config_overrides: Optional[DocDBClientConfig] = None,
db_cluster_parameter_group_name: Optional[
"capo_docdb.types.string.String"
] = None,
) -> None:
"""<p>Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.</p>
Args:
db_cluster_parameter_group_name: <p>The name of the cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be the name of an existing cluster parameter group.</p> </li> <li> <p>You can't delete a default cluster parameter group.</p> </li> <li> <p>Cannot be associated with any clusters.</p> </li> </ul>
Raises:
capo_docdb.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <code>DBParameterGroupName</code> doesn't refer to an existing parameter group. </p>
capo_docdb.errors.invalid_db_parameter_group_state_fault.InvalidDBParameterGroupStateFault: <p>The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.</p>
capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_docdb.types.delete_db_cluster_parameter_group_message.DeleteDBClusterParameterGroupMessage]",
) -> OperationResponse[None]:
import capo_docdb._operations.amazon_rd_sv19.delete_db_cluster_parameter_group
output, http_response = (
capo_docdb._operations.amazon_rd_sv19.delete_db_cluster_parameter_group.delete_db_cluster_parameter_group(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteDBClusterParameterGroup")
)
input_: capo_docdb.types.delete_db_cluster_parameter_group_message.DeleteDBClusterParameterGroupMessage = {}
if db_cluster_parameter_group_name is not None:
input_["db_cluster_parameter_group_name"] = db_cluster_parameter_group_name
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|