Skip to content

create_connect_peer async

create_connect_peer(
    connect_attachment_id: AttachmentId,
    peer_address: IPAddress,
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
    core_network_address: Optional[IPAddress] = None,
    bgp_options: Optional[BgpOptions] = None,
    inside_cidr_blocks: Optional[ConstrainedStringList] = None,
    tags: Optional[TagList] = None,
    client_token: Optional[ClientToken] = None,
    subnet_arn: Optional[SubnetArn] = None,
) -> CreateConnectPeerResponse

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).

Parameters:

  • connect_attachment_id (AttachmentId) –

    The ID of the connection attachment.

  • core_network_address (Optional[IPAddress], default: None ) –

    A Connect peer core network address. This only applies only when the protocol is GRE.

  • peer_address (IPAddress) –

    The Connect peer address.

  • bgp_options (Optional[BgpOptions], default: None ) –

    The Connect peer BGP options. This only applies only when the protocol is GRE.

  • inside_cidr_blocks (Optional[ConstrainedStringList], default: None ) –

    The inside IP addresses used for BGP peering.

  • tags (Optional[TagList], default: None ) –

    The tags associated with the peer request.

  • client_token (Optional[ClientToken], default: None ) –

    The client token associated with the request.

  • subnet_arn (Optional[SubnetArn], default: None ) –

    The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.

Raises:

Source code in docs_src/capo_networkmanager/_services/async_network_manager.py
async def create_connect_peer(
    self,
    connect_attachment_id: "capo_networkmanager.types.attachment_id.AttachmentId",
    peer_address: "capo_networkmanager.types.ip_address.IPAddress",
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
    core_network_address: Optional[
        "capo_networkmanager.types.ip_address.IPAddress"
    ] = None,
    bgp_options: Optional[
        "capo_networkmanager.types.bgp_options.BgpOptions"
    ] = None,
    inside_cidr_blocks: Optional[
        "capo_networkmanager.types.constrained_string_list.ConstrainedStringList"
    ] = None,
    tags: Optional["capo_networkmanager.types.tag_list.TagList"] = None,
    client_token: Optional[
        "capo_networkmanager.types.client_token.ClientToken"
    ] = None,
    subnet_arn: Optional["capo_networkmanager.types.subnet_arn.SubnetArn"] = None,
) -> "capo_networkmanager.types.create_connect_peer_response.CreateConnectPeerResponse":
    """<p>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).</p>

    Args:
        connect_attachment_id: <p>The ID of the connection attachment.</p>
        core_network_address: <p>A Connect peer core network address. This only applies only when the protocol is <code>GRE</code>.</p>
        peer_address: <p>The Connect peer address.</p>
        bgp_options: <p>The Connect peer BGP options. This only applies only when the protocol is <code>GRE</code>.</p>
        inside_cidr_blocks: <p>The inside IP addresses used for BGP peering.</p>
        tags: <p>The tags associated with the peer request.</p>
        client_token: <p>The client token associated with the request.</p>
        subnet_arn: <p>The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.</p>

    Raises:
        capo_networkmanager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_networkmanager.errors.conflict_exception.ConflictException: <p>There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.</p>
        capo_networkmanager.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal error.</p>
        capo_networkmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found.</p>
        capo_networkmanager.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_networkmanager.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints.</p>
        capo_networkmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_networkmanager.types.create_connect_peer_request.CreateConnectPeerRequest]",
    ) -> AsyncOperationResponse[
        "capo_networkmanager.types.create_connect_peer_response.CreateConnectPeerResponse"
    ]:
        import capo_networkmanager._operations.network_manager.create_connect_peer

        (
            output,
            http_response,
        ) = await capo_networkmanager._operations.network_manager.create_connect_peer.async_create_connect_peer(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateConnectPeer")
    )
    input_: capo_networkmanager.types.create_connect_peer_request.CreateConnectPeerRequest = {
        "connect_attachment_id": connect_attachment_id,
        "peer_address": peer_address,
    }
    if core_network_address is not None:
        input_["core_network_address"] = core_network_address
    if bgp_options is not None:
        input_["bgp_options"] = bgp_options
    if inside_cidr_blocks is not None:
        input_["inside_cidr_blocks"] = inside_cidr_blocks
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if subnet_arn is not None:
        input_["subnet_arn"] = subnet_arn

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output