:doc:`ElasticsearchService <../../es>` / Client / create_outbound_cross_cluster_search_connection

***********************************************
create_outbound_cross_cluster_search_connection
***********************************************



.. py:method:: ElasticsearchService.Client.create_outbound_cross_cluster_search_connection(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/es-2015-01-01/CreateOutboundCrossClusterSearchConnection>`_  


  **Request Syntax**
  ::

    response = client.create_outbound_cross_cluster_search_connection(
        SourceDomainInfo={
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        DestinationDomainInfo={
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        ConnectionAlias='string'
    )
    
  :type SourceDomainInfo: dict
  :param SourceDomainInfo: **[REQUIRED]** 

    Specifies the ``DomainInformation`` for the source Elasticsearch domain.

    

  
    - **OwnerId** *(string) --* 

    
    - **DomainName** *(string) --* **[REQUIRED]** 

      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      

    
    - **Region** *(string) --* 

    
  
  :type DestinationDomainInfo: dict
  :param DestinationDomainInfo: **[REQUIRED]** 

    Specifies the ``DomainInformation`` for the destination Elasticsearch domain.

    

  
    - **OwnerId** *(string) --* 

    
    - **DomainName** *(string) --* **[REQUIRED]** 

      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      

    
    - **Region** *(string) --* 

    
  
  :type ConnectionAlias: string
  :param ConnectionAlias: **[REQUIRED]** 

    Specifies the connection alias that will be used by the customer for this connection.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'SourceDomainInfo': {
              'OwnerId': 'string',
              'DomainName': 'string',
              'Region': 'string'
          },
          'DestinationDomainInfo': {
              'OwnerId': 'string',
              'DomainName': 'string',
              'Region': 'string'
          },
          'ConnectionAlias': 'string',
          'ConnectionStatus': {
              'StatusCode': 'PENDING_ACCEPTANCE'|'VALIDATING'|'VALIDATION_FAILED'|'PROVISIONING'|'ACTIVE'|'REJECTED'|'DELETING'|'DELETED',
              'Message': 'string'
          },
          'CrossClusterSearchConnectionId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The result of a ``CreateOutboundCrossClusterSearchConnection`` request. Contains the details of the newly created cross-cluster search connection.

      
      

      - **SourceDomainInfo** *(dict) --* 

        Specifies the ``DomainInformation`` for the source Elasticsearch domain.

        
        

        - **OwnerId** *(string) --* 
        

        - **DomainName** *(string) --* 

          The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          
        

        - **Region** *(string) --* 
    
      

      - **DestinationDomainInfo** *(dict) --* 

        Specifies the ``DomainInformation`` for the destination Elasticsearch domain.

        
        

        - **OwnerId** *(string) --* 
        

        - **DomainName** *(string) --* 

          The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          
        

        - **Region** *(string) --* 
    
      

      - **ConnectionAlias** *(string) --* 

        Specifies the connection alias provided during the create connection request.

        
      

      - **ConnectionStatus** *(dict) --* 

        Specifies the ``OutboundCrossClusterSearchConnectionStatus`` for the newly created connection.

        
        

        - **StatusCode** *(string) --* 

          The state code for outbound connection. This can be one of the following:

           

          
          * VALIDATING: The outbound connection request is being validated.
           
          * VALIDATION_FAILED: Validation failed for the connection request.
           
          * PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by destination domain owner.
           
          * PROVISIONING: Outbound connection request is in process.
           
          * ACTIVE: Outbound connection is active and ready to use.
           
          * REJECTED: Outbound connection request is rejected by destination domain owner.
           
          * DELETING: Outbound connection deletion is in progress.
           
          * DELETED: Outbound connection is deleted and cannot be used further.
          

          
        

        - **Message** *(string) --* 

          Specifies verbose information for the outbound connection status.

          
    
      

      - **CrossClusterSearchConnectionId** *(string) --* 

        Unique id for the created outbound connection, which is used for subsequent operations on connection.

        
  
  **Exceptions**
  
  *   :py:class:`ElasticsearchService.Client.exceptions.LimitExceededException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.InternalException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.ResourceAlreadyExistsException`

  
  *   :py:class:`ElasticsearchService.Client.exceptions.DisabledOperationException`

  