Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . opensearch ]

create-outbound-connection

Description

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service .

See also: AWS API Documentation

Synopsis

  create-outbound-connection
--local-domain-info <value>
--remote-domain-info <value>
--connection-alias <value>
[--connection-mode <value>]
[--connection-properties <value>]
[--cli-input-json <value>]
[--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>]

Options

--local-domain-info (structure)

Name and Region of the source (local) domain.

AWSDomainInformation -> (structure)

Information about an Amazon OpenSearch Service domain.

OwnerId -> (string)

The Amazon Web Services account ID of the domain owner.

DomainName -> (string)

Name of the domain.

Region -> (string)

The Amazon Web Services Region in which the domain is located.

Shorthand Syntax:

AWSDomainInformation={OwnerId=string,DomainName=string,Region=string}

JSON Syntax:

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

--remote-domain-info (structure)

Name and Region of the destination (remote) domain.

AWSDomainInformation -> (structure)

Information about an Amazon OpenSearch Service domain.

OwnerId -> (string)

The Amazon Web Services account ID of the domain owner.

DomainName -> (string)

Name of the domain.

Region -> (string)

The Amazon Web Services Region in which the domain is located.

Shorthand Syntax:

AWSDomainInformation={OwnerId=string,DomainName=string,Region=string}

JSON Syntax:

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

--connection-alias (string)

Name of the connection.

--connection-mode (string)

The connection mode.

Possible values:

• DIRECT
• VPC_ENDPOINT

--connection-properties (structure)

The ConnectionProperties for the outbound connection.

Endpoint -> (string)

Warning

The Endpoint attribute cannot be modified.

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

CrossClusterSearch -> (structure)

The connection properties for cross cluster search.

SkipUnavailable -> (string)

The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

Shorthand Syntax:

Endpoint=string,CrossClusterSearch={SkipUnavailable=string}

JSON Syntax:

{
  "Endpoint": "string",
  "CrossClusterSearch": {
    "SkipUnavailable": "ENABLED"|"DISABLED"
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

LocalDomainInfo -> (structure)

Information about the source (local) domain.

AWSDomainInformation -> (structure)

Information about an Amazon OpenSearch Service domain.

OwnerId -> (string)

The Amazon Web Services account ID of the domain owner.

DomainName -> (string)

Name of the domain.

Region -> (string)

The Amazon Web Services Region in which the domain is located.

RemoteDomainInfo -> (structure)

Information about the destination (remote) domain.

AWSDomainInformation -> (structure)

Information about an Amazon OpenSearch Service domain.

OwnerId -> (string)

The Amazon Web Services account ID of the domain owner.

DomainName -> (string)

Name of the domain.

Region -> (string)

The Amazon Web Services Region in which the domain is located.

ConnectionAlias -> (string)

Name of the connection.

ConnectionStatus -> (structure)

The status of the connection.

StatusCode -> (string)

The status code for the outbound connection. 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 the remote domain owner.
• APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
• PROVISIONING - Outbound connection request is in process.
• ACTIVE - Outbound connection is active and ready to use.
• REJECTING - Outbound connection rejection by remote domain owner is in progress.
• REJECTED - Outbound connection request is rejected by remote domain owner.
• DELETING - Outbound connection deletion is in progress.
• DELETED - Outbound connection is deleted and can no longer be used.

Message -> (string)

Verbose information for the outbound connection.

ConnectionId -> (string)

The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.

ConnectionMode -> (string)

The connection mode.

ConnectionProperties -> (structure)

The ConnectionProperties for the newly created connection.

Endpoint -> (string)

Warning

The Endpoint attribute cannot be modified.

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

CrossClusterSearch -> (structure)

The connection properties for cross cluster search.

SkipUnavailable -> (string)

The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.