Skip to main content

inbound_cross_cluster_search_connections

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

Overview

Nameinbound_cross_cluster_search_connections
TypeResource
Idaws.es.inbound_cross_cluster_search_connections

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
cross_cluster_search_connectionsarrayConsists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.
next_tokenstringPaginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_inbound_cross_cluster_search_connectionsselectregionLists all the inbound cross-cluster search connections for a destination domain.
delete_inbound_cross_cluster_search_connectiondeleteconnection_id, regionAllows the destination domain owner to delete an existing inbound cross-cluster search connection.

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.

NameDatatypeDescription
connection_idstringThe id of the inbound connection that you want to permanently delete.
regionstringAWS region (default: us-east-1)

SELECT examples

Lists all the inbound cross-cluster search connections for a destination domain.

SELECT
cross_cluster_search_connections,
next_token
FROM aws.es.inbound_cross_cluster_search_connections
WHERE region = '{{ region }}' -- required
;

DELETE examples

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

DELETE FROM aws.es.inbound_cross_cluster_search_connections
WHERE connection_id = '{{ connection_id }}' --required
AND region = '{{ region }}' --required
;