reset_db_cluster_parameter_group `async` ¶

reset_db_cluster_parameter_group(
    *,
    config_overrides: Optional[AsyncDocDBClientConfig] = None,
    db_cluster_parameter_group_name: Optional[String] = None,
    reset_all_parameters: Optional[Boolean] = None,
    parameters: Optional[ParametersList] = None,
) -> DBClusterParameterGroupNameMessage

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

Parameters:

db_cluster_parameter_group_name (Optional[String], default: None ) –

The name of the cluster parameter group to reset.
reset_all_parameters (Optional[Boolean], default: None ) –

A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
parameters (Optional[ParametersList], default: None ) –

A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

Raises:

DBParameterGroupNotFoundFault –

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

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.
UnknownServiceError –

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

Source code in docs_src/capo_docdb/_services/async_doc_db.py

async def reset_db_cluster_parameter_group(
    self,
    *,
    config_overrides: Optional[AsyncDocDBClientConfig] = None,
    db_cluster_parameter_group_name: Optional[
        "capo_docdb.types.string.String"
    ] = None,
    reset_all_parameters: Optional["capo_docdb.types.boolean.Boolean"] = None,
    parameters: Optional["capo_docdb.types.parameters_list.ParametersList"] = None,
) -> "capo_docdb.types.db_cluster_parameter_group_name_message.DBClusterParameterGroupNameMessage":
    """<p> Modifies the parameters of a 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 cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. </p> <p> When you reset 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 reboot.</p>

    Args:
        db_cluster_parameter_group_name: <p>The name of the cluster parameter group to reset.</p>
        reset_all_parameters: <p>A value that is set to <code>true</code> to reset all parameters in the cluster parameter group to their default values, and <code>false</code> otherwise. 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 cluster parameter group to reset to the default values. You can't use this parameter if the <code>ResetAllParameters</code> parameter is set to <code>true</code>.</p>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_docdb.types.reset_db_cluster_parameter_group_message.ResetDBClusterParameterGroupMessage]",
    ) -> AsyncOperationResponse[
        "capo_docdb.types.db_cluster_parameter_group_name_message.DBClusterParameterGroupNameMessage"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.reset_db_cluster_parameter_group

        (
            output,
            http_response,
        ) = await capo_docdb._operations.amazon_rd_sv19.reset_db_cluster_parameter_group.async_reset_db_cluster_parameter_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

reset_db_cluster_parameter_group async ¶

reset_db_cluster_parameter_group `async` ¶