Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

Route

Creates a Route resource in the specified project using the data included in the request.

Create a Route Resource

new Route(name: string, args?: RouteArgs, opts?: CustomResourceOptions);
@overload
def Route(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          allow_conflicting_subnetworks: Optional[bool] = None,
          description: Optional[str] = None,
          dest_range: Optional[str] = None,
          ilb_route_behavior_on_unhealthy: Optional[RouteIlbRouteBehaviorOnUnhealthy] = None,
          name: Optional[str] = None,
          network: Optional[str] = None,
          next_hop_gateway: Optional[str] = None,
          next_hop_ilb: Optional[str] = None,
          next_hop_instance: Optional[str] = None,
          next_hop_ip: Optional[str] = None,
          next_hop_network: Optional[str] = None,
          next_hop_vpn_tunnel: Optional[str] = None,
          priority: Optional[int] = None,
          project: Optional[str] = None,
          request_id: Optional[str] = None,
          tags: Optional[Sequence[str]] = None)
@overload
def Route(resource_name: str,
          args: Optional[RouteArgs] = None,
          opts: Optional[ResourceOptions] = None)
func NewRoute(ctx *Context, name string, args *RouteArgs, opts ...ResourceOption) (*Route, error)
public Route(string name, RouteArgs? args = null, CustomResourceOptions? opts = null)
public Route(String name, RouteArgs args)
public Route(String name, RouteArgs args, CustomResourceOptions options)
type: google-native:compute/alpha:Route
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args RouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args RouteArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RouteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args RouteArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Route Resource Properties

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

Inputs

The Route resource accepts the following input properties:

AllowConflictingSubnetworks bool

Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network.

Description string

An optional description of this resource. Provide this field when you create the resource.

DestRange string

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

IlbRouteBehaviorOnUnhealthy Pulumi.GoogleNative.Compute.Alpha.RouteIlbRouteBehaviorOnUnhealthy

ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing.

Name string

Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

Network string

Fully-qualified URL of the network that this route applies to.

NextHopGateway string

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

NextHopIlb string

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

NextHopInstance string

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

NextHopIp string

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

NextHopNetwork string

The URL of the local network if it should handle matching packets.

NextHopVpnTunnel string

The URL to a VpnTunnel that should handle matching packets.

Priority int

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive.

Project string
RequestId string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Tags List<string>

A list of instance tags to which this route applies.

AllowConflictingSubnetworks bool

Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network.

Description string

An optional description of this resource. Provide this field when you create the resource.

DestRange string

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

IlbRouteBehaviorOnUnhealthy RouteIlbRouteBehaviorOnUnhealthy

ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing.

Name string

Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

Network string

Fully-qualified URL of the network that this route applies to.

NextHopGateway string

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

NextHopIlb string

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

NextHopInstance string

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

NextHopIp string

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

NextHopNetwork string

The URL of the local network if it should handle matching packets.

NextHopVpnTunnel string

The URL to a VpnTunnel that should handle matching packets.

Priority int

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive.

Project string
RequestId string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Tags []string

A list of instance tags to which this route applies.

allowConflictingSubnetworks Boolean

Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network.

description String

An optional description of this resource. Provide this field when you create the resource.

destRange String

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

ilbRouteBehaviorOnUnhealthy RouteIlbRouteBehaviorOnUnhealthy

ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing.

name String

Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

network String

Fully-qualified URL of the network that this route applies to.

nextHopGateway String

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

nextHopIlb String

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

nextHopInstance String

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

nextHopIp String

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

nextHopNetwork String

The URL of the local network if it should handle matching packets.

nextHopVpnTunnel String

The URL to a VpnTunnel that should handle matching packets.

priority Integer

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive.

project String
requestId String

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

tags List<String>

A list of instance tags to which this route applies.

allowConflictingSubnetworks boolean

Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network.

description string

An optional description of this resource. Provide this field when you create the resource.

destRange string

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

ilbRouteBehaviorOnUnhealthy RouteIlbRouteBehaviorOnUnhealthy

ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing.

name string

Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

network string

Fully-qualified URL of the network that this route applies to.

nextHopGateway string

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

nextHopIlb string

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

nextHopInstance string

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

nextHopIp string

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

nextHopNetwork string

The URL of the local network if it should handle matching packets.

nextHopVpnTunnel string

The URL to a VpnTunnel that should handle matching packets.

priority number

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive.

project string
requestId string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

tags string[]

A list of instance tags to which this route applies.

allow_conflicting_subnetworks bool

Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network.

description str

An optional description of this resource. Provide this field when you create the resource.

dest_range str

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

ilb_route_behavior_on_unhealthy RouteIlbRouteBehaviorOnUnhealthy

ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing.

name str

Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

network str

Fully-qualified URL of the network that this route applies to.

next_hop_gateway str

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

next_hop_ilb str

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

next_hop_instance str

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

next_hop_ip str

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

next_hop_network str

The URL of the local network if it should handle matching packets.

next_hop_vpn_tunnel str

The URL to a VpnTunnel that should handle matching packets.

priority int

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive.

project str
request_id str

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

tags Sequence[str]

A list of instance tags to which this route applies.

allowConflictingSubnetworks Boolean

Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network.

description String

An optional description of this resource. Provide this field when you create the resource.

destRange String

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

ilbRouteBehaviorOnUnhealthy "DO_NOT_WITHDRAW_ROUTE_IF_ILB_UNHEALTHY" | "WITHDRAW_ROUTE_IF_ILB_UNHEALTHY"

ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing.

name String

Name of the resource. Provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

network String

Fully-qualified URL of the network that this route applies to.

nextHopGateway String

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

nextHopIlb String

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

nextHopInstance String

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

nextHopIp String

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

nextHopNetwork String

The URL of the local network if it should handle matching packets.

nextHopVpnTunnel String

The URL to a VpnTunnel that should handle matching packets.

priority Number

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive.

project String
requestId String

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

tags List<String>

A list of instance tags to which this route applies.

Outputs

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

AsPaths List<Pulumi.GoogleNative.Compute.Alpha.Outputs.RouteAsPathResponse>

AS path.

CreationTimestamp string

Creation timestamp in RFC3339 text format.

Id string

The provider-assigned unique ID for this managed resource.

Kind string

Type of this resource. Always compute#routes for Route resources.

NextHopInterconnectAttachment string

The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

NextHopPeering string

The network peering name that should handle matching packets, which should conform to RFC1035.

RouteStatus string

[Output only] The status of the route.

RouteType string

The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route

SelfLink string

Server-defined fully-qualified URL for this resource.

SelfLinkWithId string

Server-defined URL for this resource with the resource id.

Warnings List<Pulumi.GoogleNative.Compute.Alpha.Outputs.RouteWarningsItemResponse>

If potential misconfigurations are detected for this route, this field will be populated with warning messages.

AsPaths []RouteAsPathResponse

AS path.

CreationTimestamp string

Creation timestamp in RFC3339 text format.

Id string

The provider-assigned unique ID for this managed resource.

Kind string

Type of this resource. Always compute#routes for Route resources.

NextHopInterconnectAttachment string

The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

NextHopPeering string

The network peering name that should handle matching packets, which should conform to RFC1035.

RouteStatus string

[Output only] The status of the route.

RouteType string

The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route

SelfLink string

Server-defined fully-qualified URL for this resource.

SelfLinkWithId string

Server-defined URL for this resource with the resource id.

Warnings []RouteWarningsItemResponse

If potential misconfigurations are detected for this route, this field will be populated with warning messages.

asPaths List<RouteAsPathResponse>

AS path.

creationTimestamp String

Creation timestamp in RFC3339 text format.

id String

The provider-assigned unique ID for this managed resource.

kind String

Type of this resource. Always compute#routes for Route resources.

nextHopInterconnectAttachment String

The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

nextHopPeering String

The network peering name that should handle matching packets, which should conform to RFC1035.

routeStatus String

[Output only] The status of the route.

routeType String

The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route

selfLink String

Server-defined fully-qualified URL for this resource.

selfLinkWithId String

Server-defined URL for this resource with the resource id.

warnings List<RouteWarningsItemResponse>

If potential misconfigurations are detected for this route, this field will be populated with warning messages.

asPaths RouteAsPathResponse[]

AS path.

creationTimestamp string

Creation timestamp in RFC3339 text format.

id string

The provider-assigned unique ID for this managed resource.

kind string

Type of this resource. Always compute#routes for Route resources.

nextHopInterconnectAttachment string

The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

nextHopPeering string

The network peering name that should handle matching packets, which should conform to RFC1035.

routeStatus string

[Output only] The status of the route.

routeType string

The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route

selfLink string

Server-defined fully-qualified URL for this resource.

selfLinkWithId string

Server-defined URL for this resource with the resource id.

warnings RouteWarningsItemResponse[]

If potential misconfigurations are detected for this route, this field will be populated with warning messages.

as_paths Sequence[RouteAsPathResponse]

AS path.

creation_timestamp str

Creation timestamp in RFC3339 text format.

id str

The provider-assigned unique ID for this managed resource.

kind str

Type of this resource. Always compute#routes for Route resources.

next_hop_interconnect_attachment str

The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

next_hop_peering str

The network peering name that should handle matching packets, which should conform to RFC1035.

route_status str

[Output only] The status of the route.

route_type str

The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route

self_link str

Server-defined fully-qualified URL for this resource.

self_link_with_id str

Server-defined URL for this resource with the resource id.

warnings Sequence[RouteWarningsItemResponse]

If potential misconfigurations are detected for this route, this field will be populated with warning messages.

asPaths List<Property Map>

AS path.

creationTimestamp String

Creation timestamp in RFC3339 text format.

id String

The provider-assigned unique ID for this managed resource.

kind String

Type of this resource. Always compute#routes for Route resources.

nextHopInterconnectAttachment String

The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

nextHopPeering String

The network peering name that should handle matching packets, which should conform to RFC1035.

routeStatus String

[Output only] The status of the route.

routeType String

The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route

selfLink String

Server-defined fully-qualified URL for this resource.

selfLinkWithId String

Server-defined URL for this resource with the resource id.

warnings List<Property Map>

If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Supporting Types

RouteAsPathResponse

AsLists List<int>

The AS numbers of the AS Path.

PathSegmentType string

The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed

AsLists []int

The AS numbers of the AS Path.

PathSegmentType string

The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed

asLists List<Integer>

The AS numbers of the AS Path.

pathSegmentType String

The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed

asLists number[]

The AS numbers of the AS Path.

pathSegmentType string

The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed

as_lists Sequence[int]

The AS numbers of the AS Path.

path_segment_type str

The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed

asLists List<Number>

The AS numbers of the AS Path.

pathSegmentType String

The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed

RouteIlbRouteBehaviorOnUnhealthy

DoNotWithdrawRouteIfIlbUnhealthy
DO_NOT_WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Do not Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the ILB. This is default behavior for ilb as next hop route without IlbRouteBehavior.

WithdrawRouteIfIlbUnhealthy
WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. Currently the withdrawn route will be reinserted when the backends are restored to healthy. If you wish to prevent the re-insertion of the route and trigger the fall-back at your discretion, override the health result from the backends to signal as healthy only when ready to fallback.

RouteIlbRouteBehaviorOnUnhealthyDoNotWithdrawRouteIfIlbUnhealthy
DO_NOT_WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Do not Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the ILB. This is default behavior for ilb as next hop route without IlbRouteBehavior.

RouteIlbRouteBehaviorOnUnhealthyWithdrawRouteIfIlbUnhealthy
WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. Currently the withdrawn route will be reinserted when the backends are restored to healthy. If you wish to prevent the re-insertion of the route and trigger the fall-back at your discretion, override the health result from the backends to signal as healthy only when ready to fallback.

DoNotWithdrawRouteIfIlbUnhealthy
DO_NOT_WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Do not Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the ILB. This is default behavior for ilb as next hop route without IlbRouteBehavior.

WithdrawRouteIfIlbUnhealthy
WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. Currently the withdrawn route will be reinserted when the backends are restored to healthy. If you wish to prevent the re-insertion of the route and trigger the fall-back at your discretion, override the health result from the backends to signal as healthy only when ready to fallback.

DoNotWithdrawRouteIfIlbUnhealthy
DO_NOT_WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Do not Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the ILB. This is default behavior for ilb as next hop route without IlbRouteBehavior.

WithdrawRouteIfIlbUnhealthy
WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. Currently the withdrawn route will be reinserted when the backends are restored to healthy. If you wish to prevent the re-insertion of the route and trigger the fall-back at your discretion, override the health result from the backends to signal as healthy only when ready to fallback.

DO_NOT_WITHDRAW_ROUTE_IF_ILB_UNHEALTHY
DO_NOT_WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Do not Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the ILB. This is default behavior for ilb as next hop route without IlbRouteBehavior.

WITHDRAW_ROUTE_IF_ILB_UNHEALTHY
WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. Currently the withdrawn route will be reinserted when the backends are restored to healthy. If you wish to prevent the re-insertion of the route and trigger the fall-back at your discretion, override the health result from the backends to signal as healthy only when ready to fallback.

"DO_NOT_WITHDRAW_ROUTE_IF_ILB_UNHEALTHY"
DO_NOT_WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Do not Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the ILB. This is default behavior for ilb as next hop route without IlbRouteBehavior.

"WITHDRAW_ROUTE_IF_ILB_UNHEALTHY"
WITHDRAW_ROUTE_IF_ILB_UNHEALTHY

Withdraw route if the ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. Currently the withdrawn route will be reinserted when the backends are restored to healthy. If you wish to prevent the re-insertion of the route and trigger the fall-back at your discretion, override the health result from the backends to signal as healthy only when ready to fallback.

RouteWarningsItemDataItemResponse

Key string

A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

Value string

A warning data value corresponding to the key.

Key string

A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

Value string

A warning data value corresponding to the key.

key String

A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

value String

A warning data value corresponding to the key.

key string

A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

value string

A warning data value corresponding to the key.

key str

A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

value str

A warning data value corresponding to the key.

key String

A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

value String

A warning data value corresponding to the key.

RouteWarningsItemResponse

Code string

A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Data List<Pulumi.GoogleNative.Compute.Alpha.Inputs.RouteWarningsItemDataItemResponse>

Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Message string

A human-readable description of the warning code.

Code string

A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Data []RouteWarningsItemDataItemResponse

Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Message string

A human-readable description of the warning code.

code String

A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

data List<RouteWarningsItemDataItemResponse>

Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

message String

A human-readable description of the warning code.

code string

A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

data RouteWarningsItemDataItemResponse[]

Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

message string

A human-readable description of the warning code.

code str

A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

data Sequence[RouteWarningsItemDataItemResponse]

Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

message str

A human-readable description of the warning code.

code String

A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

data List<Property Map>

Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

message String

A human-readable description of the warning code.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0