CreateOutboundConnection
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.
Request Syntax
POST /2021-01-01/opensearch/cc/outboundConnection HTTP/1.1
Content-type: application/json
{
"ConnectionAlias": "string",
"ConnectionMode": "string",
"ConnectionProperties": {
"CrossClusterSearch": {
"SkipUnavailable": "string"
},
"Endpoint": "string"
},
"LocalDomainInfo": {
"AWSDomainInformation": {
"DomainName": "string",
"OwnerId": "string",
"Region": "string"
}
},
"RemoteDomainInfo": {
"AWSDomainInformation": {
"DomainName": "string",
"OwnerId": "string",
"Region": "string"
}
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ConnectionAlias
-
Name of the connection.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern:
[a-zA-Z][a-zA-Z0-9\-\_]+Required: Yes
- ConnectionMode
-
The connection mode.
Type: String
Valid Values:
DIRECT | VPC_ENDPOINTRequired: No
- ConnectionProperties
-
The
ConnectionPropertiesfor the outbound connection.Type: ConnectionProperties object
Required: No
- LocalDomainInfo
-
Name and Region of the source (local) domain.
Type: DomainInformationContainer object
Required: Yes
- RemoteDomainInfo
-
Name and Region of the destination (remote) domain.
Type: DomainInformationContainer object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ConnectionAlias": "string",
"ConnectionId": "string",
"ConnectionMode": "string",
"ConnectionProperties": {
"CrossClusterSearch": {
"SkipUnavailable": "string"
},
"Endpoint": "string"
},
"ConnectionStatus": {
"Message": "string",
"StatusCode": "string"
},
"LocalDomainInfo": {
"AWSDomainInformation": {
"DomainName": "string",
"OwnerId": "string",
"Region": "string"
}
},
"RemoteDomainInfo": {
"AWSDomainInformation": {
"DomainName": "string",
"OwnerId": "string",
"Region": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ConnectionAlias
-
Name of the connection.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern:
[a-zA-Z][a-zA-Z0-9\-\_]+ - ConnectionId
-
The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 256.
Pattern:
[a-z][a-z0-9\-]+ - ConnectionMode
-
The connection mode.
Type: String
Valid Values:
DIRECT | VPC_ENDPOINT - ConnectionProperties
-
The
ConnectionPropertiesfor the newly created connection.Type: ConnectionProperties object
- ConnectionStatus
-
The status of the connection.
Type: OutboundConnectionStatus object
- LocalDomainInfo
-
Information about the source (local) domain.
Type: DomainInformationContainer object
- RemoteDomainInfo
-
Information about the destination (remote) domain.
Type: DomainInformationContainer object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DisabledOperationException
-
An error occured because the client wanted to access an unsupported operation.
HTTP Status Code: 409
- InternalException
-
Request processing failed because of an unknown error, exception, or internal failure.
HTTP Status Code: 500
- LimitExceededException
-
An exception for trying to create more than the allowed number of resources or sub-resources.
HTTP Status Code: 409
- ResourceAlreadyExistsException
-
An exception for creating a resource that already exists.
HTTP Status Code: 409
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
