ReplicationPeer - Amazon OpenSearch Service
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

ReplicationPeer

A domain that another domain replicates with, and the state of that relationship.

Contents

PeerDomainArn

The Amazon Resource Name (ARN) of the peer domain.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

Required: No

PeerRole

The peer's role in the relationship, either PRIMARY or SECONDARY.

Type: String

Valid Values: PRIMARY | SECONDARY

Required: No

Status

The state of the relationship:

  • PENDING_SETUP - replication is being established.

  • ACTIVE - replication is running.

  • SWITCHING_OVER - a planned promotion is in progress.

  • FAILING_OVER - an unplanned promotion is in progress.

  • PENDING_REMOVAL - replication is being stopped.

  • DETACHED - the relationship has ended.

  • EJECTED - a failover promoted the other domain. The former primary keeps the data it had when it was ejected and stays read-only until you remove the peer, or discard that data and pair again.

  • FAILED - setup or teardown could not complete. You can still remove the relationship.

A relationship that is removed successfully no longer appears in Peers.

Type: String

Valid Values: PENDING_SETUP | ACTIVE | SWITCHING_OVER | FAILING_OVER | PENDING_REMOVAL | DETACHED | EJECTED | FAILED

Required: No

StatusMessage

An explanation of why the relationship is in its current state, when more detail is available.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: