Class RouterPeer

BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

To get more information about RouterBgpPeer, see:

Example Usage - Router Peer Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var peer = new Gcp.Compute.RouterPeer(&quot;peer&quot;, new Gcp.Compute.RouterPeerArgs
    {
        AdvertisedRoutePriority = 100,
        Interface = &quot;interface-1&quot;,
        PeerAsn = 65513,
        PeerIpAddress = &quot;169.254.1.2&quot;,
        Region = &quot;us-central1&quot;,
        Router = &quot;my-router&quot;,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

RouterPeer

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.Gcp.Compute

Assembly: Pulumi.Gcp.dll

Syntax

public class RouterPeer : CustomResource

Constructors

View Source

RouterPeer(String, RouterPeerArgs, CustomResourceOptions)

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

Declaration

public RouterPeer(string name, RouterPeerArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

View Source

AdvertisedGroups

User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.
ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.
ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network.

Declaration

public Output<ImmutableArray<string>> AdvertisedGroups { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

AdvertisedIpRanges

User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges. Structure is documented below.

Declaration

public Output<ImmutableArray<RouterPeerAdvertisedIpRange>> AdvertisedIpRanges { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<RouterPeerAdvertisedIpRange>>

View Source

AdvertisedRoutePriority

The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

Declaration

public Output<int?> AdvertisedRoutePriority { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

AdvertiseMode

User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM

Declaration

public Output<string> AdvertiseMode { get; }

Property Value

Type	Description
Output<System.String>

View Source

Interface

Name of the interface the BGP peer is associated with.

Declaration

public Output<string> Interface { get; }

Property Value

Type	Description
Output<System.String>

View Source

IpAddress

IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

Declaration

public Output<string> IpAddress { get; }

Property Value

Type	Description
Output<System.String>

View Source

ManagementType

The resource that configures and manages this BGP peer. * 'MANAGED_BY_USER' is the default value and can be managed by you or other users * 'MANAGED_BY_ATTACHMENT' is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Declaration

public Output<string> ManagementType { get; }

Property Value

Type	Description
Output<System.String>

View Source

Name

Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

PeerAsn

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

Declaration

public Output<int> PeerAsn { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

PeerIpAddress

IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Declaration

public Output<string> PeerIpAddress { get; }

Property Value

Type	Description
Output<System.String>

View Source

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

View Source

Region

Region where the router and BgpPeer reside. If it is not provided, the provider region is used.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

View Source

Router

The name of the Cloud Router in which this BgpPeer will be configured.

Declaration

public Output<string> Router { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

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

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

Declaration

public static RouterPeer Get(string name, Input<string> id, RouterPeerState 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.
RouterPeerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
RouterPeer