reset_db_cluster_parameter_group `async` ¶

reset_db_cluster_parameter_group(
    *,
    config_overrides: Optional[AsyncNeptuneClientConfig] = 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 DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

Parameters:

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

The name of the DB 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 DB 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 DB 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 does not 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 cannot 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_neptune/_services/async_neptune.py

async def reset_db_cluster_parameter_group(
    self,
    *,
    config_overrides: Optional[AsyncNeptuneClientConfig] = None,
    db_cluster_parameter_group_name: Optional[
        "capo_neptune.types.string.String"
    ] = None,
    reset_all_parameters: Optional["capo_neptune.types.boolean.Boolean"] = None,
    parameters: Optional[
        "capo_neptune.types.parameters_list.ParametersList"
    ] = None,
) -> "capo_neptune.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 <a>RebootDBInstance</a> request. You must call <a>RebootDBInstance</a> for every DB instance in your DB cluster that you want the updated static parameter to apply to.</p>

    Args:
        db_cluster_parameter_group_name: <p>The name of the DB 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 DB 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 DB 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_neptune.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <i>DBParameterGroupName</i> does not refer to an existing DB parameter group.</p>
        capo_neptune.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 cannot delete it when the parameter group is in this state.</p>
        capo_neptune.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        (
            output,
            http_response,
        ) = await capo_neptune._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_neptune.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` ¶