odb / Client / create_odb_peering_connection

create_odb_peering_connection

odb.Client.create_odb_peering_connection(**kwargs)

Creates a peering connection between an ODB network and either another ODB network or a customer-owned VPC.

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

See also: AWS API Documentation

Request Syntax

response = client.create_odb_peering_connection(
    odbNetworkId='string',
    peerNetworkId='string',
    displayName='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • odbNetworkId (string) –

    [REQUIRED]

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

  • peerNetworkId (string) –

    [REQUIRED]

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

  • displayName (string) – The display name for the ODB peering connection.

  • clientToken (string) –

    The client token for the ODB peering connection request.

    Constraints:

    • Must be unique for each request.

    This field is autopopulated if not provided.

  • tags (dict) –

    The tags to assign to the ODB peering connection.

    • (string) –

      • (string) –

Return type:

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.

      Valid Values: provisioning | active | terminating | terminated | failed

    • statusReason (string) –

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

    • odbPeeringConnectionId (string) –

      The unique identifier of the ODB peering connection.

Exceptions