inbound_connections

Creates, updates, deletes, gets or lists an inbound_connections resource.

Overview

Name	inbound_connections
Type	Resource
Id	aws.opensearch.inbound_connections

Fields

The following fields are returned by SELECT queries:

describe_inbound_connections

Name	Datatype	Description
connections	array	List of inbound connections.
next_token	string	When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_inbound_connections	select	region		Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
delete_inbound_connection	delete	connection_id, region		Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connection_id	string	The ID of the inbound connection to permanently delete.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_inbound_connections

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

SELECT
connections,
next_token
FROM aws.opensearch.inbound_connections
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_inbound_connection

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

DELETE FROM aws.opensearch.inbound_connections
WHERE connection_id = '{{ connection_id }}' --required
AND region = '{{ region }}' --required
;