| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DocumentDB.FailoverDBCluster
Description
Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
Synopsis
- data FailoverDBCluster = FailoverDBCluster' {}
- newFailoverDBCluster :: FailoverDBCluster
- failoverDBCluster_dbClusterIdentifier :: Lens' FailoverDBCluster (Maybe Text)
- failoverDBCluster_targetDBInstanceIdentifier :: Lens' FailoverDBCluster (Maybe Text)
- data FailoverDBClusterResponse = FailoverDBClusterResponse' {
- dbCluster :: Maybe DBCluster
- httpStatus :: Int
- newFailoverDBClusterResponse :: Int -> FailoverDBClusterResponse
- failoverDBClusterResponse_dbCluster :: Lens' FailoverDBClusterResponse (Maybe DBCluster)
- failoverDBClusterResponse_httpStatus :: Lens' FailoverDBClusterResponse Int
Creating a Request
data FailoverDBCluster Source #
Represents the input to FailoverDBCluster.
See: newFailoverDBCluster smart constructor.
Constructors
| FailoverDBCluster' | |
Fields
| |
Instances
newFailoverDBCluster :: FailoverDBCluster Source #
Create a value of FailoverDBCluster 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:dbClusterIdentifier:FailoverDBCluster', failoverDBCluster_dbClusterIdentifier - A cluster identifier to force a failover for. This parameter is not case
sensitive.
Constraints:
- Must match the identifier of an existing
DBCluster.
$sel:targetDBInstanceIdentifier:FailoverDBCluster', failoverDBCluster_targetDBInstanceIdentifier - The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Amazon DocumentDB
replica in the cluster. For example, mydbcluster-replica1.
Request Lenses
failoverDBCluster_dbClusterIdentifier :: Lens' FailoverDBCluster (Maybe Text) Source #
A cluster identifier to force a failover for. This parameter is not case sensitive.
Constraints:
- Must match the identifier of an existing
DBCluster.
failoverDBCluster_targetDBInstanceIdentifier :: Lens' FailoverDBCluster (Maybe Text) Source #
The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Amazon DocumentDB
replica in the cluster. For example, mydbcluster-replica1.
Destructuring the Response
data FailoverDBClusterResponse Source #
See: newFailoverDBClusterResponse smart constructor.
Constructors
| FailoverDBClusterResponse' | |
Fields
| |
Instances
newFailoverDBClusterResponse Source #
Create a value of FailoverDBClusterResponse 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:dbCluster:FailoverDBClusterResponse', failoverDBClusterResponse_dbCluster - Undocumented member.
$sel:httpStatus:FailoverDBClusterResponse', failoverDBClusterResponse_httpStatus - The response's http status code.
Response Lenses
failoverDBClusterResponse_dbCluster :: Lens' FailoverDBClusterResponse (Maybe DBCluster) Source #
Undocumented member.
failoverDBClusterResponse_httpStatus :: Lens' FailoverDBClusterResponse Int Source #
The response's http status code.