outbound_cross_cluster_search_connections

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

Overview

Name	outbound_cross_cluster_search_connections
Type	Resource
Id	aws.es.outbound_cross_cluster_search_connections

Fields

The following fields are returned by SELECT queries:

describe_outbound_cross_cluster_search_connections

Name	Datatype	Description
cross_cluster_search_connections	array	Consists of list of OutboundCrossClusterSearchConnection 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_outbound_cross_cluster_search_connections	select	region		Lists all the outbound cross-cluster search connections for a source domain.
create_outbound_cross_cluster_search_connection	insert	region, SourceDomainInfo, DestinationDomainInfo, ConnectionAlias		Creates a new cross-cluster search connection from a source domain to a destination domain.
delete_outbound_cross_cluster_search_connection	delete	connection_id, region		Allows the source domain owner to delete an existing outbound 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 outbound connection that you want to permanently delete.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_outbound_cross_cluster_search_connections

Lists all the outbound cross-cluster search connections for a source domain.

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

INSERT examples

create_outbound_cross_cluster_search_connection

Creates a new cross-cluster search connection from a source domain to a destination domain.

INSERT INTO aws.es.outbound_cross_cluster_search_connections (
SourceDomainInfo,
DestinationDomainInfo,
ConnectionAlias,
region
)
SELECT 
'{{ SourceDomainInfo }}' /* required */,
'{{ DestinationDomainInfo }}' /* required */,
'{{ ConnectionAlias }}' /* required */,
'{{ region }}'
RETURNING
connection_alias,
connection_status,
cross_cluster_search_connection_id,
destination_domain_info,
source_domain_info
;

Manifest

# Description fields are for documentation purposes
- name: outbound_cross_cluster_search_connections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the outbound_cross_cluster_search_connections resource.
  - name: SourceDomainInfo
    value:
      OwnerId: "{{ OwnerId }}"
      DomainName: "{{ DomainName }}"
      Region: "{{ Region }}"
  - name: DestinationDomainInfo
    value:
      OwnerId: "{{ OwnerId }}"
      DomainName: "{{ DomainName }}"
      Region: "{{ Region }}"
  - name: ConnectionAlias
    value: "{{ ConnectionAlias }}"

DELETE examples

delete_outbound_cross_cluster_search_connection

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

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