Synchronously, gracefully suspends a data source that has the health state of Running and disables existing connections. This operation immediately marks the data source as suspended and no further connections are created. Idle (not reserved) connections are marked as disabled. After a timeout period for the suspend operation, all remaining connections in the pool are marked as suspended and the following exception is thrown for any operations on the connection, indicating that the data source is suspended: java.sql.SQLRecoverableException: Connection has been administratively disabled. Try later. If graceful suspend is done as part of a graceful shutdown operation, connections are immediately closed when no longer reserved or at the end of the timeout period. If not done as part of a shutdown operation, these connections remain in the pool and are not closed because the pool may be resumed.

By default, the timeout period is 60 seconds. You can change the value of this timeout period by configuring or dynamically setting Inactive Connection Timeout Seconds to a non-zero value.

Setting IgnoreInUseConnectionsEnabled to false causes the operation to fail if in-use connections exist.

If successful, the health state is set to Suspended

This is a privileged operation that can only be invoked by an authorized user.