RouterPeerArgs class

The set of arguments for RouterPeer. The set of arguments for RouterPeer.

Constructors

RouterPeerArgs({Input<String?>? advertiseMode, Input<List<String>?>? advertisedGroups, Input<List<RouterPeerAdvertisedIpRange>?>? advertisedIpRanges, Input<int?>? advertisedRoutePriority, Input<RouterPeerBfd?>? bfd, Input<List<RouterPeerCustomLearnedIpRange>?>? customLearnedIpRanges, Input<int?>? customLearnedRoutePriority, Input<String?>? deletionPolicy, Input<bool?>? enable, Input<bool?>? enableIpv4, Input<bool?>? enableIpv6, Input<List<String>?>? exportPolicies, Input<List<String>?>? importPolicies, required Input<String> interface, Input<String?>? ipAddress, Input<String?>? ipv4NexthopAddress, Input<String?>? ipv6NexthopAddress, Input<RouterPeerMd5AuthenticationKey?>? md5AuthenticationKey, Input<String?>? name, required Input<int> peerAsn, Input<String?>? peerIpAddress, Input<String?>? peerIpv4NexthopAddress, Input<String?>? peerIpv6NexthopAddress, Input<String?>? project, Input<String?>? region, required Input<String> router, Input<String?>? routerApplianceInstance, Input<bool?>? zeroAdvertisedRoutePriority, Input<bool?>? zeroCustomLearnedRoutePriority})
Creates a new RouterPeerArgs. advertiseMode User-specified flag to indicate which mode to use for advertisement. advertisedGroups User-specified list of prefix groups to advertise in custom advertisedIpRanges User-specified list of individual IP ranges to advertise in advertisedRoutePriority The priority of routes advertised to this BGP peer. bfd BFD configuration for the BGP peering. customLearnedIpRanges The custom learned route IP address range. Must be a valid CIDR-formatted prefix. customLearnedRoutePriority The user-defined custom learned route priority for a BGP session. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". enable The status of the BGP peer connection. If set to false, any active session enableIpv4 Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. enableIpv6 Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. exportPolicies (Optional, Beta) importPolicies (Optional, Beta) interface Name of the interface the BGP peer is associated with. ipAddress IP address of the interface inside Google Cloud Platform. ipv4NexthopAddress IPv4 address of the interface inside Google Cloud Platform. ipv6NexthopAddress IPv6 address of the interface inside Google Cloud Platform. md5AuthenticationKey Configuration for MD5 authentication on the BGP session. name Name of this BGP peer. The name must be 1-63 characters long, peerAsn Peer BGP Autonomous System Number (ASN). peerIpAddress IP address of the BGP interface outside Google Cloud Platform. peerIpv4NexthopAddress IPv4 address of the BGP interface outside Google Cloud Platform. peerIpv6NexthopAddress IPv6 address of the BGP interface outside Google Cloud Platform. project The ID of the project in which the resource belongs. region Region where the router and BgpPeer reside. router The name of the Cloud Router in which this BgpPeer will be configured. routerApplianceInstance The URI of the VM instance that is used as third-party router appliances zeroAdvertisedRoutePriority The user-defined zero-advertised-route-priority for a advertised-route-priority in BGP session. zeroCustomLearnedRoutePriority The user-defined zero-custom-learned-route-priority for a custom-learned-route-priority in BGP session.
const
RouterPeerArgs.fromMap(Map<String, dynamic> map)
factory

Properties

advertisedGroups → Input<List<String>?>?
User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:
final
advertisedIpRanges → Input<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.
final
advertisedRoutePriority → Input<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.
final
advertiseMode → Input<String?>?
User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: DEFAULT, CUSTOM Default value is DEFAULT. Possible values are: DEFAULT, CUSTOM.
final
bfd → Input<RouterPeerBfd?>?
BFD configuration for the BGP peering. Structure is documented below.
final
customLearnedIpRanges → Input<List<RouterPeerCustomLearnedIpRange>?>?
The custom learned route IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128. Structure is documented below.
final
customLearnedRoutePriority → Input<int?>?
The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
enable → Input<bool?>?
The status of the BGP peer connection. If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true.
final
enableIpv4 → Input<bool?>?
Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.
final
enableIpv6 → Input<bool?>?
Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
final
exportPolicies → Input<List<String>?>?
(Optional, Beta) routers.list of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type.
final
hashCode → int
The hash code for this object.
no setterinherited
importPolicies → Input<List<String>?>?
(Optional, Beta) routers.list of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type.
final
interface → Input<String>
Name of the interface the BGP peer is associated with.
final
ipAddress → Input<String?>?
IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
final
ipv4NexthopAddress → Input<String?>?
IPv4 address of the interface inside Google Cloud Platform.
final
ipv6NexthopAddress → Input<String?>?
IPv6 address of the interface inside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
final
md5AuthenticationKey → Input<RouterPeerMd5AuthenticationKey?>?
Configuration for MD5 authentication on the BGP session. Structure is documented below.
final
name → Input<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.
final
peerAsn → Input<int>
Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
final
peerIpAddress → Input<String?>?
IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if ipAddress is set.
final
peerIpv4NexthopAddress → Input<String?>?
IPv4 address of the BGP interface outside Google Cloud Platform.
final
peerIpv6NexthopAddress → Input<String?>?
IPv6 address of the BGP interface outside Google Cloud Platform. The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
region → Input<String?>?
Region where the router and BgpPeer reside. If it is not provided, the provider region is used.
final
router → Input<String>
The name of the Cloud Router in which this BgpPeer will be configured.
final
routerApplianceInstance → Input<String?>?
The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
zeroAdvertisedRoutePriority → Input<bool?>?
The user-defined zero-advertised-route-priority for a advertised-route-priority in BGP session. This value has to be set true to force the advertisedRoutePriority to be 0.
final
zeroCustomLearnedRoutePriority → Input<bool?>?
The user-defined zero-custom-learned-route-priority for a custom-learned-route-priority in BGP session. This value has to be set true to force the customLearnedRoutePriority to be 0.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited