Skip to content

Create Connect Peer

networkmanager_create_connect_peer R Documentation

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance

Description

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

Usage

networkmanager_create_connect_peer(ConnectAttachmentId,
  CoreNetworkAddress, PeerAddress, BgpOptions, InsideCidrBlocks, Tags,
  ClientToken, SubnetArn)

Arguments

ConnectAttachmentId

[required] The ID of the connection attachment.

CoreNetworkAddress

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

PeerAddress

[required] The Connect peer address.

BgpOptions

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

InsideCidrBlocks

The inside IP addresses used for BGP peering.

Tags

The tags associated with the peer request.

ClientToken

The client token associated with the request.

SubnetArn

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

Value

A list with the following syntax:

list(
  ConnectPeer = list(
    CoreNetworkId = "string",
    ConnectAttachmentId = "string",
    ConnectPeerId = "string",
    EdgeLocation = "string",
    State = "CREATING"|"FAILED"|"AVAILABLE"|"DELETING",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    Configuration = list(
      CoreNetworkAddress = "string",
      PeerAddress = "string",
      InsideCidrBlocks = list(
        "string"
      ),
      Protocol = "GRE"|"NO_ENCAP",
      BgpConfigurations = list(
        list(
          CoreNetworkAsn = 123,
          PeerAsn = 123,
          CoreNetworkAddress = "string",
          PeerAddress = "string"
        )
      )
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    SubnetArn = "string",
    LastModificationErrors = list(
      list(
        Code = "EDGE_LOCATION_NO_FREE_IPS"|"EDGE_LOCATION_PEER_DUPLICATE"|"SUBNET_NOT_FOUND"|"IP_OUTSIDE_SUBNET_CIDR_RANGE"|"INVALID_INSIDE_CIDR_BLOCK"|"NO_ASSOCIATED_CIDR_BLOCK",
        Message = "string",
        ResourceArn = "string",
        RequestId = "string"
      )
    )
  )
)

Request syntax

svc$create_connect_peer(
  ConnectAttachmentId = "string",
  CoreNetworkAddress = "string",
  PeerAddress = "string",
  BgpOptions = list(
    PeerAsn = 123
  ),
  InsideCidrBlocks = list(
    "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ClientToken = "string",
  SubnetArn = "string"
)