Skip to content

Resource: awsDxBgpPeer

Provides a Direct Connect BGP peer resource.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dxBgpPeer.DxBgpPeer(this, "peer", {
  addressFamily: "ipv6",
  bgpAsn: 65351,
  virtualInterfaceId: "${aws_dx_private_virtual_interface.foo.id}",
});

Argument Reference

The following arguments are supported:

  • addressFamily - (Required) The address family for the BGP peer. ipv4 or ipv6.
  • bgpAsn - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
  • virtualInterfaceId - (Required) The ID of the Direct Connect virtual interface on which to create the BGP peer.
  • amazonAddress - (Optional) The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.
  • bgpAuthKey - (Optional) The authentication key for BGP configuration.
  • customerAddress - (Optional) The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The ID of the BGP peer resource.
  • bgpStatus - The Up/Down state of the BGP peer.
  • bgpPeerId - The ID of the BGP peer.
  • awsDevice - The Direct Connect endpoint on which the BGP peer terminates.

Timeouts

Configuration options:

  • create - (Default 10M)
  • delete - (Default 10M)