v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html">Cross-cluster search for Amazon OpenSearch Service</a>.

post/2021-01-01/opensearch/cc/outboundConnection

Request body

ConnectionAliasstring required

Name of the connection.

ConnectionMode'DIRECT' | 'VPC_ENDPOINT'
<p>The connection mode for the cross-cluster connection.</p> <ul> <li> <p> <b>DIRECT</b> - Used for cross-cluster search or cross-cluster replication.</p> </li> <li> <p> <b>VPC_ENDPOINT</b> - Used for remote reindex between Amazon OpenSearch Service VPC domains.</p> </li> </ul>

Response

Success

ConnectionAliasstring

Name of the connection.

ConnectionIdstring

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

ConnectionMode'DIRECT' | 'VPC_ENDPOINT'

The connection mode.