inbound_cross_cluster_search_connections
Creates, updates, deletes, gets or lists an inbound_cross_cluster_search_connections resource.
Overview
| Name | inbound_cross_cluster_search_connections |
| Type | Resource |
| Id | aws.es.inbound_cross_cluster_search_connections |
Fields
The following fields are returned by SELECT queries:
- describe_inbound_cross_cluster_search_connections
| Name | Datatype | Description |
|---|---|---|
cross_cluster_search_connections | array | Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria. |
next_token | string | Paginated 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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_inbound_cross_cluster_search_connections | select | region | Lists all the inbound cross-cluster search connections for a destination domain. | |
delete_inbound_cross_cluster_search_connection | delete | connection_id, region | Allows 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.
| Name | Datatype | Description |
|---|---|---|
connection_id | string | The id of the inbound connection that you want to permanently delete. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_inbound_cross_cluster_search_connections
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
- delete_inbound_cross_cluster_search_connection
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
;