libZSservicesZSamazonka-neptuneZSamazonka-neptune
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Neptune.FailoverDBCluster

Description

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.

Synopsis

Creating a Request

data FailoverDBCluster Source #

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

Instances details
Eq FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Read FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Show FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Generic FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Associated Types

type Rep FailoverDBCluster :: Type -> Type #

NFData FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Methods

rnf :: FailoverDBCluster -> () #

Hashable FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

AWSRequest FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Associated Types

type AWSResponse FailoverDBCluster #

ToHeaders FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

ToPath FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

ToQuery FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

type Rep FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

type Rep FailoverDBCluster = D1 ('MetaData "FailoverDBCluster" "Amazonka.Neptune.FailoverDBCluster" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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))))
type AWSResponse FailoverDBCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

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 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) Source #

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) Source #

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 Source #

See: newFailoverDBClusterResponse smart constructor.

Constructors

FailoverDBClusterResponse' 

Fields

Instances

Instances details
Eq FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Read FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Show FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Generic FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

Associated Types

type Rep FailoverDBClusterResponse :: Type -> Type #

NFData FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

type Rep FailoverDBClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverDBCluster

type Rep FailoverDBClusterResponse = D1 ('MetaData "FailoverDBClusterResponse" "Amazonka.Neptune.FailoverDBCluster" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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 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