[ aws . opensearch ]

describe-domain-replication

Description

Describes the replication arrangement that a domain participates in, including the domain’s role and the state of its relationship with each peer.

A domain that is not replicating is returned with an empty Peers list and no Role . Returns ResourceNotFoundException if the domain does not exist.

See also: AWS API Documentation

Synopsis

  describe-domain-replication
--domain-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--domain-name (string) [required]

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

Constraints:

• min: 3
• max: 28
• pattern: [a-z][a-z0-9\-]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

DomainArn -> (string)

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

Constraints:

• min: 1
• max: 512
• pattern: arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

Role -> (string)

The domain’s role in the arrangement, either PRIMARY or SECONDARY . Absent when the domain is not replicating.

Possible values:

• PRIMARY
• SECONDARY

Peers -> (list)

The domains that this domain replicates with. Each entry carries the state of that one relationship. Empty when the domain is not replicating.

(structure)

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

PeerDomainArn -> (string)

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

Constraints:

• min: 1
• max: 512
• pattern: arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

PeerRole -> (string)

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

Possible values:

• PRIMARY
• SECONDARY

Status -> (string)

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 .

Possible values:

• PENDING_SETUP
• ACTIVE
• SWITCHING_OVER
• FAILING_OVER
• PENDING_REMOVAL
• DETACHED
• EJECTED
• FAILED

StatusMessage -> (string)

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

Constraints:

• max: 2048