reset_db_cluster_parameter_group ¶

def reset_db_cluster_parameter_group(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    db_cluster_parameter_group_name: Optional[
        "capo_rds.types.string.String"
    ] = None,
    reset_all_parameters: Optional["capo_rds.types.boolean.Boolean"] = None,
    parameters: Optional["capo_rds.types.parameters_list.ParametersList"] = None,
) -> "capo_rds.types.db_cluster_parameter_group_name_message.DBClusterParameterGroupNameMessage":
    """<p>Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters.</p> <p>When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance restart or <code>RebootDBInstance</code> request. You must call <code>RebootDBInstance</code> for every DB instance in your DB cluster that you want the updated static parameter to apply to.</p> <p>For more information on Amazon Aurora DB clusters, 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 to reset.</p>
        reset_all_parameters: <p>Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the <code>Parameters</code> parameter.</p>
        parameters: <p>A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the <code>ResetAllParameters</code> parameter is enabled.</p>

    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 reset all parameters to their default values
        The following example resets all parameter values in a customer-created DB cluster parameter group to their default values.

        >>> client.reset_db_cluster_parameter_group(db_cluster_parameter_group_name='mydbclpg', reset_all_parameters=True)
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.reset_db_cluster_parameter_group_message.ResetDBClusterParameterGroupMessage]",
    ) -> OperationResponse[
        "capo_rds.types.db_cluster_parameter_group_name_message.DBClusterParameterGroupNameMessage"
    ]:
        import capo_rds._operations.amazon_rd_sv19.reset_db_cluster_parameter_group

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.reset_db_cluster_parameter_group.reset_db_cluster_parameter_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ResetDBClusterParameterGroup")
    )
    input_: capo_rds.types.reset_db_cluster_parameter_group_message.ResetDBClusterParameterGroupMessage = {}
    if db_cluster_parameter_group_name is not None:
        input_["db_cluster_parameter_group_name"] = db_cluster_parameter_group_name
    if reset_all_parameters is not None:
        input_["reset_all_parameters"] = reset_all_parameters
    if parameters is not None:
        input_["parameters"] = parameters

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