outbound_connections

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

Overview

Name	outbound_connections
Type	Resource
Id	aws.opensearch.outbound_connections

Fields

The following fields are returned by SELECT queries:

describe_outbound_connections

Name	Datatype	Description
connections	array	List of outbound connections that match the filter criteria.
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_outbound_connections	select	region		Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
create_outbound_connection	insert	region, LocalDomainInfo, RemoteDomainInfo, ConnectionAlias		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.
delete_outbound_connection	delete	connection_id, region		Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound 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 outbound connection you want to permanently delete.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_outbound_connections

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

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

INSERT examples

create_outbound_connection

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.

INSERT INTO aws.opensearch.outbound_connections (
LocalDomainInfo,
RemoteDomainInfo,
ConnectionAlias,
ConnectionMode,
ConnectionProperties,
region
)
SELECT 
'{{ LocalDomainInfo }}' /* required */,
'{{ RemoteDomainInfo }}' /* required */,
'{{ ConnectionAlias }}' /* required */,
'{{ ConnectionMode }}',
'{{ ConnectionProperties }}',
'{{ region }}'
RETURNING
connection_alias,
connection_id,
connection_mode,
connection_properties,
connection_status,
local_domain_info,
remote_domain_info
;

Manifest

# Description fields are for documentation purposes
- name: outbound_connections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the outbound_connections resource.
  - name: LocalDomainInfo
    description: |
      Container for information about an OpenSearch Service domain.
    value:
      AWSDomainInformation:
        OwnerId: "{{ OwnerId }}"
        DomainName: "{{ DomainName }}"
        Region: "{{ Region }}"
  - name: RemoteDomainInfo
    description: |
      Container for information about an OpenSearch Service domain.
    value:
      AWSDomainInformation:
        OwnerId: "{{ OwnerId }}"
        DomainName: "{{ DomainName }}"
        Region: "{{ Region }}"
  - name: ConnectionAlias
    value: "{{ ConnectionAlias }}"
  - name: ConnectionMode
    value: "{{ ConnectionMode }}"
    description: |
      The connection mode for the cross-cluster connection. DIRECT - Used for cross-cluster search or cross-cluster replication. VPC_ENDPOINT - Used for remote reindex between Amazon OpenSearch Service VPC domains.
    valid_values: ['DIRECT', 'VPC_ENDPOINT']
  - name: ConnectionProperties
    description: |
      The connection properties of an outbound connection.
    value:
      Endpoint: "{{ Endpoint }}"
      CrossClusterSearch:
        SkipUnavailable: "{{ SkipUnavailable }}"

DELETE examples

delete_outbound_connection

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

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