:doc:`odb <../../odb>` / Client / create_odb_peering_connection

*****************************
create_odb_peering_connection
*****************************



.. py:method:: odb.Client.create_odb_peering_connection(**kwargs)

  

  Creates a peering connection between an ODB network and a VPC.

   

  A peering connection enables private connectivity between the networks for application-tier communication.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/odb-2024-08-20/CreateOdbPeeringConnection>`_  


  **Request Syntax**
  ::

    response = client.create_odb_peering_connection(
        odbNetworkId='string',
        peerNetworkId='string',
        displayName='string',
        peerNetworkCidrsToBeAdded=[
            'string',
        ],
        clientToken='string',
        tags={
            'string': 'string'
        }
    )
    
  :type odbNetworkId: string
  :param odbNetworkId: **[REQUIRED]** 

    The unique identifier of the ODB network that initiates the peering connection.

    

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

    The unique identifier of the peer network. This can be either a VPC ID or another ODB network ID.

    

  
  :type displayName: string
  :param displayName: 

    The display name for the ODB peering connection.

    

  
  :type peerNetworkCidrsToBeAdded: list
  :param peerNetworkCidrsToBeAdded: 

    A list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.

    

  
    - *(string) --* 

    

  :type clientToken: string
  :param clientToken: 

    The client token for the ODB peering connection request.

     

    Constraints:

     

    
    * Must be unique for each request.
    

    This field is autopopulated if not provided.

  
  :type tags: dict
  :param tags: 

    The tags to assign to the ODB peering connection.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'displayName': 'string',
          'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
          'statusReason': 'string',
          'odbPeeringConnectionId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **displayName** *(string) --* 

        The display name of the ODB peering connection.

        
      

      - **status** *(string) --* 

        The status of the ODB peering connection.

        
      

      - **statusReason** *(string) --* 

        The reason for the current status of the ODB peering connection.

        
      

      - **odbPeeringConnectionId** *(string) --* 

        The unique identifier of the ODB peering connection.

        
  
  **Exceptions**
  
  *   :py:class:`odb.Client.exceptions.ThrottlingException`

  
  *   :py:class:`odb.Client.exceptions.ValidationException`

  
  *   :py:class:`odb.Client.exceptions.ConflictException`

  
  *   :py:class:`odb.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`odb.Client.exceptions.InternalServerException`

  
  *   :py:class:`odb.Client.exceptions.ResourceNotFoundException`

  