NetworkManager / Client / create_connect_peer

create_connect_peer

NetworkManager.Client.create_connect_peer(**kwargs)

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

See also: AWS API Documentation

Request Syntax

response = client.create_connect_peer(
    ConnectAttachmentId='string',
    CoreNetworkAddress='string',
    PeerAddress='string',
    BgpOptions={
        'PeerAsn': 123
    },
    InsideCidrBlocks=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string',
    SubnetArn='string'
)

Parameters:

• ConnectAttachmentId (string) –

  [REQUIRED]

  The ID of the connection attachment.

• CoreNetworkAddress (string) – A Connect peer core network address.

• PeerAddress (string) –

  [REQUIRED]

  The Connect peer address.

• BgpOptions (dict) –

  The Connect peer BGP options.

  • PeerAsn (integer) –

    The Peer ASN of the BGP.

• InsideCidrBlocks (list) –

  The inside IP addresses used for BGP peering.

  • (string) –

• Tags (list) –

  The tags associated with the peer request.

  • (dict) –

    Describes a tag.

    • Key (string) –

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value (string) –

      The tag value.

      Constraints: Maximum length of 256 characters.

• ClientToken (string) –

  The client token associated with the request.

  This field is autopopulated if not provided.

• SubnetArn (string) – The subnet ARN for the Connect peer.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectPeer': {
        'CoreNetworkId': 'string',
        'ConnectAttachmentId': 'string',
        'ConnectPeerId': 'string',
        'EdgeLocation': 'string',
        'State': 'CREATING'|'FAILED'|'AVAILABLE'|'DELETING',
        'CreatedAt': datetime(2015, 1, 1),
        'Configuration': {
            'CoreNetworkAddress': 'string',
            'PeerAddress': 'string',
            'InsideCidrBlocks': [
                'string',
            ],
            'Protocol': 'GRE'|'NO_ENCAP',
            'BgpConfigurations': [
                {
                    'CoreNetworkAsn': 123,
                    'PeerAsn': 123,
                    'CoreNetworkAddress': 'string',
                    'PeerAddress': 'string'
                },
            ]
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SubnetArn': 'string'
    }
}

Response Structure

• (dict) –

  • ConnectPeer (dict) –

    The response to the request.

    • CoreNetworkId (string) –

      The ID of a core network.

    • ConnectAttachmentId (string) –

      The ID of the attachment to connect.

    • ConnectPeerId (string) –

      The ID of the Connect peer.

    • EdgeLocation (string) –

      The Connect peer Regions where edges are located.

    • State (string) –

      The state of the Connect peer.

    • CreatedAt (datetime) –

      The timestamp when the Connect peer was created.

    • Configuration (dict) –

      The configuration of the Connect peer.

      • CoreNetworkAddress (string) –

        The IP address of a core network.

      • PeerAddress (string) –

        The IP address of the Connect peer.

      • InsideCidrBlocks (list) –

        The inside IP addresses used for a Connect peer configuration.

        • (string) –

      • Protocol (string) –

        The protocol used for a Connect peer configuration.

      • BgpConfigurations (list) –

        The Connect peer BGP configurations.

        • (dict) –

          Describes a core network BGP configuration.

          • CoreNetworkAsn (integer) –

            The ASN of the Coret Network.

          • PeerAsn (integer) –

            The ASN of the Connect peer.

          • CoreNetworkAddress (string) –

            The address of a core network.

          • PeerAddress (string) –

            The address of a core network Connect peer.

    • Tags (list) –

      The list of key-value tags associated with the Connect peer.

      • (dict) –

        Describes a tag.

        • Key (string) –

          The tag key.

          Constraints: Maximum length of 128 characters.

        • Value (string) –

          The tag value.

          Constraints: Maximum length of 256 characters.

    • SubnetArn (string) –

      The subnet ARN for the Connect peer.

Exceptions

• NetworkManager.Client.exceptions.ValidationException

• NetworkManager.Client.exceptions.AccessDeniedException

• NetworkManager.Client.exceptions.ResourceNotFoundException

• NetworkManager.Client.exceptions.ConflictException

• NetworkManager.Client.exceptions.ThrottlingException

• NetworkManager.Client.exceptions.InternalServerException