Class BgpPeer

Provides a Direct Connect BGP peer resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var peer = new Aws.DirectConnect.BgpPeer("peer", new Aws.DirectConnect.BgpPeerArgs
    {
        AddressFamily = "ipv6",
        BgpAsn = 65351,
        VirtualInterfaceId = aws_dx_private_virtual_interface.Foo.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

BgpPeer

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.DirectConnect

Assembly: Pulumi.Aws.dll

Syntax

public class BgpPeer : CustomResource

Constructors

BgpPeer(String, BgpPeerArgs, CustomResourceOptions)

Create a BgpPeer resource with the given unique name, arguments, and options.

Declaration

public BgpPeer(string name, BgpPeerArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
BgpPeerArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AddressFamily

The address family for the BGP peer. ipv4 or ipv6.

Declaration

public Output<string> AddressFamily { get; }

Property Value

Type	Description
Output<System.String>

AmazonAddress

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.

Declaration

public Output<string> AmazonAddress { get; }

Property Value

Type	Description
Output<System.String>

AwsDevice

The Direct Connect endpoint on which the BGP peer terminates.

Declaration

public Output<string> AwsDevice { get; }

Property Value

Type	Description
Output<System.String>

BgpAsn

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Declaration

public Output<int> BgpAsn { get; }

Property Value

Type	Description
Output<System.Int32>

BgpAuthKey

The authentication key for BGP configuration.

Declaration

public Output<string> BgpAuthKey { get; }

Property Value

Type	Description
Output<System.String>

BgpPeerId

The ID of the BGP peer.

Declaration

public Output<string> BgpPeerId { get; }

Property Value

Type	Description
Output<System.String>

BgpStatus

The Up/Down state of the BGP peer.

Declaration

public Output<string> BgpStatus { get; }

Property Value

Type	Description
Output<System.String>

CustomerAddress

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.

Declaration

public Output<string> CustomerAddress { get; }

Property Value

Type	Description
Output<System.String>

VirtualInterfaceId

The ID of the Direct Connect virtual interface on which to create the BGP peer.

Declaration

public Output<string> VirtualInterfaceId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, BgpPeerState, CustomResourceOptions)

Get an existing BgpPeer resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static BgpPeer Get(string name, Input<string> id, BgpPeerState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
BgpPeerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
BgpPeer