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:

API documentation
How-to Guides
- Google Cloud Router

Create a RouterPeer Resource

new RouterPeer(name: string, args: RouterPeerArgs, opts?: CustomResourceOptions);

def RouterPeer(resource_name, opts=None, advertise_mode=None, advertised_groups=None, advertised_ip_ranges=None, advertised_route_priority=None, interface=None, name=None, peer_asn=None, peer_ip_address=None, project=None, region=None, router=None, __props__=None);

func NewRouterPeer(ctx *Context, name string, args RouterPeerArgs, opts ...ResourceOption) (*RouterPeer, error)

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

name string: The unique name of the resource.
args RouterPeerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RouterPeerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RouterPeerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

RouterPeer Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The RouterPeer resource accepts the following input properties:

Interface string: Name of the interface the BGP peer is associated with.
PeerAsn int: Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
PeerIpAddress string: IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
Router string: The name of the Cloud Router in which this BgpPeer will be configured.
AdvertiseMode string: User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM
AdvertisedGroups List<string>: 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.
AdvertisedIpRanges List<RouterPeerAdvertisedIpRangeArgs>: 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.
AdvertisedRoutePriority int: 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.
Name string: 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Region where the router and BgpPeer reside. If it is not provided, the provider region is used.

Interface string: Name of the interface the BGP peer is associated with.
PeerAsn int: Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
PeerIpAddress string: IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
Router string: The name of the Cloud Router in which this BgpPeer will be configured.
AdvertiseMode string: User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM
AdvertisedGroups []string: 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.
AdvertisedIpRanges []RouterPeerAdvertisedIpRange: 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.
AdvertisedRoutePriority int: 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.
Name string: 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Region where the router and BgpPeer reside. If it is not provided, the provider region is used.

interface string: Name of the interface the BGP peer is associated with.
peerAsn number: Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
peerIpAddress string: IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
router string: The name of the Cloud Router in which this BgpPeer will be configured.
advertiseMode string: User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM
advertisedGroups string[]: 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.
advertisedIpRanges RouterPeerAdvertisedIpRange[]: 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.
advertisedRoutePriority number: 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.
name string: 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.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: Region where the router and BgpPeer reside. If it is not provided, the provider region is used.

interface str: Name of the interface the BGP peer is associated with.
peer_asn float: Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
peer_ip_address str: IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
router str: The name of the Cloud Router in which this BgpPeer will be configured.
advertise_mode str: User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM
advertised_groups List[str]: 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.
advertised_ip_ranges List[RouterPeerAdvertisedIpRange]: 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.
advertised_route_priority float: 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.
name str: 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.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: Region where the router and BgpPeer reside. If it is not provided, the provider region is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the RouterPeer resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
IpAddress string: IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
ManagementType string: 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.

Id string: The provider-assigned unique ID for this managed resource.
IpAddress string: IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
ManagementType string: 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.

id string: The provider-assigned unique ID for this managed resource.
ipAddress string: IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
managementType string: 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.

id str: The provider-assigned unique ID for this managed resource.
ip_address str: IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
management_type str: 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.

Look up an Existing RouterPeer Resource

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

public static get(name: string, id: Input<ID>, state?: RouterPeerState, opts?: CustomResourceOptions): RouterPeer

static get(resource_name, id, opts=None, advertise_mode=None, advertised_groups=None, advertised_ip_ranges=None, advertised_route_priority=None, interface=None, ip_address=None, management_type=None, name=None, peer_asn=None, peer_ip_address=None, project=None, region=None, router=None, __props__=None);

func GetRouterPeer(ctx *Context, name string, id IDInput, state *RouterPeerState, opts ...ResourceOption) (*RouterPeer, error)

public static RouterPeer Get(string name, Input<string> id, RouterPeerState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AdvertiseMode string: User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM
AdvertisedGroups List<string>: 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.
AdvertisedIpRanges List<RouterPeerAdvertisedIpRangeArgs>: 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.
AdvertisedRoutePriority int: 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.
Interface string: Name of the interface the BGP peer is associated with.
IpAddress string: IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
ManagementType string: 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.
Name string: 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.
PeerAsn int: Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
PeerIpAddress string: IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
Router string: The name of the Cloud Router in which this BgpPeer will be configured.

AdvertiseMode string: User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM
AdvertisedGroups []string: 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.
AdvertisedIpRanges []RouterPeerAdvertisedIpRange: 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.
AdvertisedRoutePriority int: 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.
Interface string: Name of the interface the BGP peer is associated with.
IpAddress string: IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
ManagementType string: 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.
Name string: 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.
PeerAsn int: Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
PeerIpAddress string: IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region string: Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
Router string: The name of the Cloud Router in which this BgpPeer will be configured.

advertiseMode string: User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM
advertisedGroups string[]: 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.
advertisedIpRanges RouterPeerAdvertisedIpRange[]: 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.
advertisedRoutePriority number: 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.
interface string: Name of the interface the BGP peer is associated with.
ipAddress string: IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
managementType string: 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.
name string: 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.
peerAsn number: Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
peerIpAddress string: IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region string: Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
router string: The name of the Cloud Router in which this BgpPeer will be configured.

advertise_mode str: User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM
advertised_groups List[str]: 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.
advertised_ip_ranges List[RouterPeerAdvertisedIpRange]: 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.
advertised_route_priority float: 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.
interface str: Name of the interface the BGP peer is associated with.
ip_address str: IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
management_type str: 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.
name str: 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.
peer_asn float: Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
peer_ip_address str: IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region str: Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
router str: The name of the Cloud Router in which this BgpPeer will be configured.

Supporting Types

RouterPeerAdvertisedIpRange

See the input and output API doc for this type.

Range string: The IP range to advertise. The value must be a CIDR-formatted string.
Description string: User-specified description for the IP range.

Range string: The IP range to advertise. The value must be a CIDR-formatted string.
Description string: User-specified description for the IP range.

range string: The IP range to advertise. The value must be a CIDR-formatted string.
description string: User-specified description for the IP range.

range str: The IP range to advertise. The value must be a CIDR-formatted string.
description str: User-specified description for the IP range.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud