delete_db_cluster_parameter_group `async` ¶

delete_db_cluster_parameter_group(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    db_cluster_parameter_group_name: Optional[String] = None,
) -> None

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameters:

db_cluster_parameter_group_name (Optional[String], default: None ) –
The name of the DB cluster parameter group.

Constraints:
- Must be the name of an existing DB cluster parameter group.
- You can't delete a default DB cluster parameter group.
- Can't be associated with any DB clusters.

Raises:

DBParameterGroupNotFoundFault –

DBParameterGroupName doesn't refer to an existing DB parameter group.
InvalidDBParameterGroupStateFault –

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To delete a DB cluster parameter group The following example deletes the specified DB cluster parameter group.

>>> await client.delete_db_cluster_parameter_group(db_cluster_parameter_group_name='mydbclusterparametergroup')

Source code in docs_src/capo_rds/_services/async_rds.py

async def delete_db_cluster_parameter_group(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    db_cluster_parameter_group_name: Optional[
        "capo_rds.types.string.String"
    ] = None,
) -> None:
    """<p>Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.</p> <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB cluster deployments</a> in the <i>Amazon RDS User Guide</i>.</p>

    Args:
        db_cluster_parameter_group_name: <p>The name of the DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be the name of an existing DB cluster parameter group.</p> </li> <li> <p>You can't delete a default DB cluster parameter group.</p> </li> <li> <p>Can't be associated with any DB clusters.</p> </li> </ul>

    Raises:
        capo_rds.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group.</p>
        capo_rds.errors.invalid_db_parameter_group_state_fault.InvalidDBParameterGroupStateFault: <p>The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To delete a DB cluster parameter group
        The following example deletes the specified DB cluster parameter group.

        >>> await client.delete_db_cluster_parameter_group(db_cluster_parameter_group_name='mydbclusterparametergroup')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.delete_db_cluster_parameter_group_message.DeleteDBClusterParameterGroupMessage]",
    ) -> AsyncOperationResponse[None]:
        import capo_rds._operations.amazon_rd_sv19.delete_db_cluster_parameter_group

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.delete_db_cluster_parameter_group.async_delete_db_cluster_parameter_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDBClusterParameterGroup")
    )
    input_: capo_rds.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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_db_cluster_parameter_group async ¶

delete_db_cluster_parameter_group `async` ¶