Amazonka.Neptune.FailoverDBCluster

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

Creating a Request

data FailoverDBCluster

See: newFailoverDBCluster smart constructor.

Constructors

FailoverDBCluster'

Fields

• dbClusterIdentifier :: Maybe Text

  A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

  Constraints:

  • Must match the identifier of an existing DBCluster.
• targetDBInstanceIdentifier :: Maybe Text

  The name of the instance to promote to the primary instance.

  You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1.

Instances

ToHeaders FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

toHeaders :: FailoverDBCluster -> [Header]

ToPath FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

toPath :: FailoverDBCluster -> ByteString

ToQuery FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

toQuery :: FailoverDBCluster -> QueryString

AWSRequest FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Associated Types

type AWSResponse FailoverDBCluster

Methods

request :: (Service -> Service) -> FailoverDBCluster -> Request FailoverDBCluster

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy FailoverDBCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse FailoverDBCluster)))

Generic FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Associated Types

type Rep FailoverDBCluster :: Type -> Type

Methods

from :: FailoverDBCluster -> Rep FailoverDBCluster x

to :: Rep FailoverDBCluster x -> FailoverDBCluster

Read FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

readsPrec :: Int -> ReadS FailoverDBCluster

readList :: ReadS [FailoverDBCluster]

readPrec :: ReadPrec FailoverDBCluster

readListPrec :: ReadPrec [FailoverDBCluster]

Show FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

showsPrec :: Int -> FailoverDBCluster -> ShowS

show :: FailoverDBCluster -> String

showList :: [FailoverDBCluster] -> ShowS

NFData FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

rnf :: FailoverDBCluster -> ()

Eq FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

(==) :: FailoverDBCluster -> FailoverDBCluster -> Bool

(/=) :: FailoverDBCluster -> FailoverDBCluster -> Bool

Hashable FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

hashWithSalt :: Int -> FailoverDBCluster -> Int

hash :: FailoverDBCluster -> Int

type AWSResponse FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

type AWSResponse FailoverDBCluster = FailoverDBClusterResponse

type Rep FailoverDBCluster

Defined in Amazonka.Neptune.FailoverDBCluster

type Rep FailoverDBCluster = D1 ('MetaData "FailoverDBCluster" "Amazonka.Neptune.FailoverDBCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "FailoverDBCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "targetDBInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newFailoverDBCluster :: FailoverDBCluster

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:

FailoverDBCluster, failoverDBCluster_dbClusterIdentifier - A DB 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 Read Replica in the DB cluster. For example, mydbcluster-replica1.

Request Lenses

failoverDBCluster_dbClusterIdentifier :: Lens' FailoverDBCluster (Maybe Text)

A DB 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)

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1.

Destructuring the Response

data FailoverDBClusterResponse

See: newFailoverDBClusterResponse smart constructor.

Constructors

FailoverDBClusterResponse'

Fields

• dbCluster :: Maybe DBCluster
• httpStatus :: Int

  The response's http status code.

Instances

Generic FailoverDBClusterResponse

Defined in Amazonka.Neptune.FailoverDBCluster

Associated Types

type Rep FailoverDBClusterResponse :: Type -> Type

Methods

from :: FailoverDBClusterResponse -> Rep FailoverDBClusterResponse x

to :: Rep FailoverDBClusterResponse x -> FailoverDBClusterResponse

Read FailoverDBClusterResponse

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

readsPrec :: Int -> ReadS FailoverDBClusterResponse

readList :: ReadS [FailoverDBClusterResponse]

readPrec :: ReadPrec FailoverDBClusterResponse

readListPrec :: ReadPrec [FailoverDBClusterResponse]

Show FailoverDBClusterResponse

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

showsPrec :: Int -> FailoverDBClusterResponse -> ShowS

show :: FailoverDBClusterResponse -> String

showList :: [FailoverDBClusterResponse] -> ShowS

NFData FailoverDBClusterResponse

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

rnf :: FailoverDBClusterResponse -> ()

Eq FailoverDBClusterResponse

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

(==) :: FailoverDBClusterResponse -> FailoverDBClusterResponse -> Bool

(/=) :: FailoverDBClusterResponse -> FailoverDBClusterResponse -> Bool

type Rep FailoverDBClusterResponse

Defined in Amazonka.Neptune.FailoverDBCluster

type Rep FailoverDBClusterResponse = D1 ('MetaData "FailoverDBClusterResponse" "Amazonka.Neptune.FailoverDBCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "FailoverDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newFailoverDBClusterResponse

Arguments

:: Int

$sel:httpStatus:FailoverDBClusterResponse'

-> FailoverDBClusterResponse

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)

Undocumented member.

failoverDBClusterResponse_httpStatus :: Lens' FailoverDBClusterResponse Int

The response's http status code.