[ aws . es ]

create-outbound-cross-cluster-search-connection

Description

Creates a new cross-cluster search connection from a source domain to a destination domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-outbound-cross-cluster-search-connection
--source-domain-info <value>
--destination-domain-info <value>
--connection-alias <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--source-domain-info (structure)

Specifies the `` DomainInformation`` for the source Elasticsearch domain.

OwnerId -> (string)

DomainName -> (string)

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

Shorthand Syntax:

OwnerId=string,DomainName=string,Region=string

JSON Syntax:

{
  "OwnerId": "string",
  "DomainName": "string",
  "Region": "string"
}

--destination-domain-info (structure)

Specifies the `` DomainInformation`` for the destination Elasticsearch domain.

OwnerId -> (string)

DomainName -> (string)

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

Shorthand Syntax:

OwnerId=string,DomainName=string,Region=string

JSON Syntax:

{
  "OwnerId": "string",
  "DomainName": "string",
  "Region": "string"
}

--connection-alias (string)

Specifies the connection alias that will be used by the customer for this connection.

--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.

See ‘aws help’ for descriptions of global parameters.

Output

SourceDomainInfo -> (structure)

Specifies the `` DomainInformation`` for the source Elasticsearch domain.

OwnerId -> (string)

DomainName -> (string)

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

DestinationDomainInfo -> (structure)

Specifies the `` DomainInformation`` for the destination Elasticsearch domain.

OwnerId -> (string)

DomainName -> (string)

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Region -> (string)

ConnectionAlias -> (string)

Specifies the connection alias provided during the create connection request.

ConnectionStatus -> (structure)

Specifies the `` OutboundCrossClusterSearchConnectionStatus`` for the newly created connection.

StatusCode -> (string)

The state code for outbound connection. This can be one of the following:

  • VALIDATING: The outbound connection request is being validated.

  • VALIDATION_FAILED: Validation failed for the connection request.

  • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by destination domain owner.

  • PROVISIONING: Outbound connection request is in process.

  • ACTIVE: Outbound connection is active and ready to use.

  • REJECTED: Outbound connection request is rejected by destination domain owner.

  • DELETING: Outbound connection deletion is in progress.

  • DELETED: Outbound connection is deleted and cannot be used further.

Message -> (string)

Specifies verbose information for the outbound connection status.

CrossClusterSearchConnectionId -> (string)

Unique id for the created outbound connection, which is used for subsequent operations on connection.