| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.RDS.RebootDBInstance
Description
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the
DB cluster with the RebootDBCluster operation.
Synopsis
- data RebootDBInstance = RebootDBInstance' {}
- newRebootDBInstance :: Text -> RebootDBInstance
- rebootDBInstance_forceFailover :: Lens' RebootDBInstance (Maybe Bool)
- rebootDBInstance_dbInstanceIdentifier :: Lens' RebootDBInstance Text
- data RebootDBInstanceResponse = RebootDBInstanceResponse' {}
- newRebootDBInstanceResponse :: Int -> RebootDBInstanceResponse
- rebootDBInstanceResponse_dbInstance :: Lens' RebootDBInstanceResponse (Maybe DBInstance)
- rebootDBInstanceResponse_httpStatus :: Lens' RebootDBInstanceResponse Int
Creating a Request
data RebootDBInstance Source #
See: newRebootDBInstance smart constructor.
Constructors
| RebootDBInstance' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> RebootDBInstance |
Create a value of RebootDBInstance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forceFailover:RebootDBInstance', rebootDBInstance_forceFailover - A value that indicates whether the reboot is conducted through a
Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
RebootDBInstance, rebootDBInstance_dbInstanceIdentifier - The DB instance identifier. This parameter is stored as a lowercase
string.
Constraints:
- Must match the identifier of an existing DBInstance.
Request Lenses
rebootDBInstance_forceFailover :: Lens' RebootDBInstance (Maybe Bool) Source #
A value that indicates whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
rebootDBInstance_dbInstanceIdentifier :: Lens' RebootDBInstance Text Source #
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
- Must match the identifier of an existing DBInstance.
Destructuring the Response
data RebootDBInstanceResponse Source #
See: newRebootDBInstanceResponse smart constructor.
Constructors
| RebootDBInstanceResponse' | |
Fields
| |
Instances
newRebootDBInstanceResponse Source #
Create a value of RebootDBInstanceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbInstance:RebootDBInstanceResponse', rebootDBInstanceResponse_dbInstance - Undocumented member.
$sel:httpStatus:RebootDBInstanceResponse', rebootDBInstanceResponse_httpStatus - The response's http status code.
Response Lenses
rebootDBInstanceResponse_dbInstance :: Lens' RebootDBInstanceResponse (Maybe DBInstance) Source #
Undocumented member.
rebootDBInstanceResponse_httpStatus :: Lens' RebootDBInstanceResponse Int Source #
The response's http status code.