Router

Represents a Router resource.

To get more information about Router, see:

API documentation
How-to Guides
- Google Cloud Router

Create a Router Resource

new Router(name: string, args: RouterArgs, opts?: CustomResourceOptions);

def Router(resource_name, opts=None, bgp=None, description=None, name=None, network=None, project=None, region=None, __props__=None);

func NewRouter(ctx *Context, name string, args RouterArgs, opts ...ResourceOption) (*Router, error)

public Router(string name, RouterArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args RouterArgs: 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 RouterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

Router Resource Properties

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

Inputs

The Router resource accepts the following input properties:

Network string: A reference to the network to which this router belongs.
Bgp RouterBgpArgs: BGP information specific to this router. Structure is documented below.
Description string: User-specified description for the IP range.
Name string: Name of the resource. 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 resides.

Network string: A reference to the network to which this router belongs.
Bgp RouterBgp: BGP information specific to this router. Structure is documented below.
Description string: User-specified description for the IP range.
Name string: Name of the resource. 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 resides.

network string: A reference to the network to which this router belongs.
bgp RouterBgp: BGP information specific to this router. Structure is documented below.
description string: User-specified description for the IP range.
name string: Name of the resource. 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 resides.

network str: A reference to the network to which this router belongs.
bgp Dict[RouterBgp]: BGP information specific to this router. Structure is documented below.
description str: User-specified description for the IP range.
name str: Name of the resource. 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 resides.

Outputs

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

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

creationTimestamp string: Creation timestamp in RFC3339 text format.
id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.

creation_timestamp str: Creation timestamp in RFC3339 text format.
id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.

Look up an Existing Router Resource

Get an existing Router 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?: RouterState, opts?: CustomResourceOptions): Router

static get(resource_name, id, opts=None, bgp=None, creation_timestamp=None, description=None, name=None, network=None, project=None, region=None, self_link=None, __props__=None);

func GetRouter(ctx *Context, name string, id IDInput, state *RouterState, opts ...ResourceOption) (*Router, error)

public static Router Get(string name, Input<string> id, RouterState? 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:

Bgp RouterBgpArgs: BGP information specific to this router. Structure is documented below.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: User-specified description for the IP range.
Name string: Name of the resource. 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.
Network string: A reference to the network to which this router belongs.
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 resides.
SelfLink string: The URI of the created resource.

Bgp RouterBgp: BGP information specific to this router. Structure is documented below.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: User-specified description for the IP range.
Name string: Name of the resource. 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.
Network string: A reference to the network to which this router belongs.
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 resides.
SelfLink string: The URI of the created resource.

bgp RouterBgp: BGP information specific to this router. Structure is documented below.
creationTimestamp string: Creation timestamp in RFC3339 text format.
description string: User-specified description for the IP range.
name string: Name of the resource. 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.
network string: A reference to the network to which this router belongs.
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 resides.
selfLink string: The URI of the created resource.

bgp Dict[RouterBgp]: BGP information specific to this router. Structure is documented below.
creation_timestamp str: Creation timestamp in RFC3339 text format.
description str: User-specified description for the IP range.
name str: Name of the resource. 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.
network str: A reference to the network to which this router belongs.
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 resides.
self_link str: The URI of the created resource.

Supporting Types

RouterBgp

See the input and output API doc for this type.

Asn int: Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
AdvertiseMode string: User-specified flag to indicate which mode to use for advertisement.
AdvertisedGroups List<string>: User-specified list of prefix groups 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 groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. This enum field has the one valid value: ALL_SUBNETS
AdvertisedIpRanges List<RouterBgpAdvertisedIpRangeArgs>: 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.

Asn int: Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
AdvertiseMode string: User-specified flag to indicate which mode to use for advertisement.
AdvertisedGroups []string: User-specified list of prefix groups 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 groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. This enum field has the one valid value: ALL_SUBNETS
AdvertisedIpRanges []RouterBgpAdvertisedIpRange: 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.

asn number: Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
advertiseMode string: User-specified flag to indicate which mode to use for advertisement.
advertisedGroups string[]: User-specified list of prefix groups 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 groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. This enum field has the one valid value: ALL_SUBNETS
advertisedIpRanges RouterBgpAdvertisedIpRange[]: 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.

asn float: Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
advertise_mode str: User-specified flag to indicate which mode to use for advertisement.
advertised_groups List[str]: User-specified list of prefix groups 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 groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. This enum field has the one valid value: ALL_SUBNETS
advertised_ip_ranges List[RouterBgpAdvertisedIpRange]: 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.

RouterBgpAdvertisedIpRange

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