import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Represents a Route resource. * * A route is a rule that specifies how certain packets should be handled by * the virtual network. Routes are associated with virtual machines by tag, * and the set of routes for a particular virtual machine is called its * routing table. For each packet leaving a virtual machine, the system * searches that virtual machine's routing table for a single best matching * route. * * Routes match packets by destination IP address, preferring smaller or more * specific ranges over larger ones. If there is a tie, the system selects * the route with the smallest priority value. If there is still a tie, it * uses the layer three and four packet headers to select just one of the * remaining matching routes. The packet is then forwarded as specified by * the nextHop field of the winning route -- either to another virtual * machine destination, a virtual machine gateway or a Compute * Engine-operated gateway. Packets that do not match any route in the * sending virtual machine's routing table will be dropped. * * A Route resource must have exactly one specification of either * nextHopGateway, nextHopInstance, nextHopIp, nextHopVpnTunnel, or * nextHopIlb. * * To get more information about Route, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/routes) * * How-to Guides * * [Using Routes](https://cloud.google.com/vpc/docs/using-routes) * * ## Example Usage * * ### Route Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const defaultNetwork = new gcp.compute.Network("default", {name: "compute-network"}); * const _default = new gcp.compute.Route("default", { * name: "network-route", * destRange: "15.0.0.0/24", * network: defaultNetwork.name, * nextHopIp: "10.132.1.5", * priority: 100, * }); * ``` * ### Route Ilb * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.Network("default", { * name: "compute-network", * autoCreateSubnetworks: false, * }); * const defaultSubnetwork = new gcp.compute.Subnetwork("default", { * name: "compute-subnet", * ipCidrRange: "10.0.1.0/24", * region: "us-central1", * network: _default.id, * }); * const hc = new gcp.compute.HealthCheck("hc", { * name: "proxy-health-check", * checkIntervalSec: 1, * timeoutSec: 1, * tcpHealthCheck: { * port: 80, * }, * }); * const backend = new gcp.compute.RegionBackendService("backend", { * name: "compute-backend", * region: "us-central1", * healthChecks: hc.id, * }); * const defaultForwardingRule = new gcp.compute.ForwardingRule("default", { * name: "compute-forwarding-rule", * region: "us-central1", * loadBalancingScheme: "INTERNAL", * backendService: backend.id, * allPorts: true, * network: _default.name, * subnetwork: defaultSubnetwork.name, * }); * const route_ilb = new gcp.compute.Route("route-ilb", { * name: "route-ilb", * destRange: "0.0.0.0/0", * network: _default.name, * nextHopIlb: defaultForwardingRule.id, * priority: 2000, * }); * ``` * ### Route Ilb Vip * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const producer = new gcp.compute.Network("producer", { * name: "producer-vpc", * autoCreateSubnetworks: false, * }); * const producerSubnetwork = new gcp.compute.Subnetwork("producer", { * name: "producer-subnet", * ipCidrRange: "10.0.1.0/24", * region: "us-central1", * network: producer.id, * }); * const consumer = new gcp.compute.Network("consumer", { * name: "consumer-vpc", * autoCreateSubnetworks: false, * }); * const consumerSubnetwork = new gcp.compute.Subnetwork("consumer", { * name: "consumer-subnet", * ipCidrRange: "10.0.2.0/24", * region: "us-central1", * network: consumer.id, * }); * const peering1 = new gcp.compute.NetworkPeering("peering1", { * name: "peering-producer-to-consumer", * network: consumer.id, * peerNetwork: producer.id, * }); * const peering2 = new gcp.compute.NetworkPeering("peering2", { * name: "peering-consumer-to-producer", * network: producer.id, * peerNetwork: consumer.id, * }); * const hc = new gcp.compute.HealthCheck("hc", { * name: "proxy-health-check", * checkIntervalSec: 1, * timeoutSec: 1, * tcpHealthCheck: { * port: 80, * }, * }); * const backend = new gcp.compute.RegionBackendService("backend", { * name: "compute-backend", * region: "us-central1", * healthChecks: hc.id, * }); * const _default = new gcp.compute.ForwardingRule("default", { * name: "compute-forwarding-rule", * region: "us-central1", * loadBalancingScheme: "INTERNAL", * backendService: backend.id, * allPorts: true, * network: producer.name, * subnetwork: producerSubnetwork.name, * }); * const route_ilb = new gcp.compute.Route("route-ilb", { * name: "route-ilb", * destRange: "0.0.0.0/0", * network: consumer.name, * nextHopIlb: _default.ipAddress, * priority: 2000, * tags: [ * "tag1", * "tag2", * ], * }, { * dependsOn: [ * peering1, * peering2, * ], * }); * ``` * * ## Import * * Route can be imported using any of these accepted formats: * * * `projects/{{project}}/global/routes/{{name}}` * * `{{project}}/{{name}}` * * `{{name}}` * * When using the `pulumi import` command, Route can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/route:Route default projects/{{project}}/global/routes/{{name}} * $ pulumi import gcp:compute/route:Route default {{project}}/{{name}} * $ pulumi import gcp:compute/route:Route default {{name}} * ``` */ export declare class Route extends pulumi.CustomResource { /** * Get an existing Route resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: RouteState, opts?: pulumi.CustomResourceOptions): Route; /** * Returns true if the given object is an instance of Route. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Route; /** * Structure is documented below. */ readonly asPaths: pulumi.Output; /** * Creation timestamp in RFC3339 text format. */ readonly creationTimestamp: pulumi.Output; /** * 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. */ readonly deletionPolicy: pulumi.Output; /** * An optional description of this resource. Provide this property * when you create the resource. */ readonly description: pulumi.Output; /** * The destination range of outgoing packets that this route applies to. * Only IPv4 is supported. */ readonly destRange: pulumi.Output; /** * 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?` 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. */ readonly name: pulumi.Output; /** * The network that this route applies to. */ readonly network: pulumi.Output; /** * URL to a gateway that should handle matching packets. * Currently, you can only specify the internet gateway, using a full or * partial valid URL: * * `https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway` * * `projects/project/global/gateways/default-internet-gateway` * * `global/gateways/default-internet-gateway` * * The string `default-internet-gateway`. */ readonly nextHopGateway: pulumi.Output; /** * The hub network that should handle matching packets, which should conform to RFC1035. */ readonly nextHopHub: pulumi.Output; /** * The IP address or URL to a forwarding rule of type * loadBalancingScheme=INTERNAL that should handle matching * packets. * With the GA provider you can only specify the forwarding * rule as a partial or full URL. For example, the following * are all valid values: * * 10.128.0.56 * * https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule * * regions/region/forwardingRules/forwardingRule * When the beta provider, you can also specify the IP address * of a forwarding rule from the same VPC or any peered VPC. * Note that this can only be used when the destinationRange is * a public (non-RFC 1918) IP CIDR range. */ readonly nextHopIlb: pulumi.Output; /** * 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/instance` * * `projects/project/zones/zone/instances/instance` * * `zones/zone/instances/instance` * * Just the instance name, with the zone in `nextHopInstanceZone`. */ readonly nextHopInstance: pulumi.Output; /** * (Optional when `nextHopInstance` is * specified) The zone of the instance specified in * `nextHopInstance`. Omit if `nextHopInstance` is specified as * a URL. */ readonly nextHopInstanceZone: pulumi.Output; /** * Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions. */ readonly nextHopInterRegionCost: pulumi.Output; /** * Network IP address of an instance that should handle matching packets. */ readonly nextHopIp: pulumi.Output; /** * Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network. */ readonly nextHopMed: pulumi.Output; /** * URL to a Network that should handle matching packets. */ readonly nextHopNetwork: pulumi.Output; /** * Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. */ readonly nextHopOrigin: pulumi.Output; /** * The network peering name that should handle matching packets, which should conform to RFC1035. */ readonly nextHopPeering: pulumi.Output; /** * URL to a VpnTunnel that should handle matching packets. */ readonly nextHopVpnTunnel: pulumi.Output; /** * Additional params passed with the request, but not persisted as part of resource payload * Structure is documented below. */ readonly params: pulumi.Output; /** * 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 the case of two routes with equal prefix length, the one with the * lowest-numbered priority value wins. * Default value is 1000. Valid range is 0 through 65535. */ readonly priority: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The status of the route, which can be one of the following values: * - 'ACTIVE' for an active route * - 'INACTIVE' for an inactive route */ readonly routeStatus: pulumi.Output; /** * 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 */ readonly routeType: pulumi.Output; /** * The URI of the created resource. */ readonly selfLink: pulumi.Output; /** * A list of instance tags to which this route applies. */ readonly tags: pulumi.Output; /** * If potential misconfigurations are detected for this route, this field will be populated with warning messages. * Structure is documented below. */ readonly warnings: pulumi.Output; /** * Create a Route resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: RouteArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Route resources. */ export interface RouteState { /** * Structure is documented below. */ asPaths?: pulumi.Input[] | undefined>; /** * Creation timestamp in RFC3339 text format. */ creationTimestamp?: pulumi.Input; /** * 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. */ deletionPolicy?: pulumi.Input; /** * An optional description of this resource. Provide this property * when you create the resource. */ description?: pulumi.Input; /** * The destination range of outgoing packets that this route applies to. * Only IPv4 is supported. */ destRange?: pulumi.Input; /** * 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?` 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. */ name?: pulumi.Input; /** * The network that this route applies to. */ network?: pulumi.Input; /** * URL to a gateway that should handle matching packets. * Currently, you can only specify the internet gateway, using a full or * partial valid URL: * * `https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway` * * `projects/project/global/gateways/default-internet-gateway` * * `global/gateways/default-internet-gateway` * * The string `default-internet-gateway`. */ nextHopGateway?: pulumi.Input; /** * The hub network that should handle matching packets, which should conform to RFC1035. */ nextHopHub?: pulumi.Input; /** * The IP address or URL to a forwarding rule of type * loadBalancingScheme=INTERNAL that should handle matching * packets. * With the GA provider you can only specify the forwarding * rule as a partial or full URL. For example, the following * are all valid values: * * 10.128.0.56 * * https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule * * regions/region/forwardingRules/forwardingRule * When the beta provider, you can also specify the IP address * of a forwarding rule from the same VPC or any peered VPC. * Note that this can only be used when the destinationRange is * a public (non-RFC 1918) IP CIDR range. */ nextHopIlb?: pulumi.Input; /** * 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/instance` * * `projects/project/zones/zone/instances/instance` * * `zones/zone/instances/instance` * * Just the instance name, with the zone in `nextHopInstanceZone`. */ nextHopInstance?: pulumi.Input; /** * (Optional when `nextHopInstance` is * specified) The zone of the instance specified in * `nextHopInstance`. Omit if `nextHopInstance` is specified as * a URL. */ nextHopInstanceZone?: pulumi.Input; /** * Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions. */ nextHopInterRegionCost?: pulumi.Input; /** * Network IP address of an instance that should handle matching packets. */ nextHopIp?: pulumi.Input; /** * Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network. */ nextHopMed?: pulumi.Input; /** * URL to a Network that should handle matching packets. */ nextHopNetwork?: pulumi.Input; /** * Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. */ nextHopOrigin?: pulumi.Input; /** * The network peering name that should handle matching packets, which should conform to RFC1035. */ nextHopPeering?: pulumi.Input; /** * URL to a VpnTunnel that should handle matching packets. */ nextHopVpnTunnel?: pulumi.Input; /** * Additional params passed with the request, but not persisted as part of resource payload * Structure is documented below. */ params?: pulumi.Input; /** * 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 the case of two routes with equal prefix length, the one with the * lowest-numbered priority value wins. * Default value is 1000. Valid range is 0 through 65535. */ priority?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The status of the route, which can be one of the following values: * - 'ACTIVE' for an active route * - 'INACTIVE' for an inactive route */ routeStatus?: pulumi.Input; /** * 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 */ routeType?: pulumi.Input; /** * The URI of the created resource. */ selfLink?: pulumi.Input; /** * A list of instance tags to which this route applies. */ tags?: pulumi.Input[] | undefined>; /** * If potential misconfigurations are detected for this route, this field will be populated with warning messages. * Structure is documented below. */ warnings?: pulumi.Input[] | undefined>; } /** * The set of arguments for constructing a Route resource. */ export interface RouteArgs { /** * 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. */ deletionPolicy?: pulumi.Input; /** * An optional description of this resource. Provide this property * when you create the resource. */ description?: pulumi.Input; /** * The destination range of outgoing packets that this route applies to. * Only IPv4 is supported. */ destRange: pulumi.Input; /** * 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?` 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. */ name?: pulumi.Input; /** * The network that this route applies to. */ network: pulumi.Input; /** * URL to a gateway that should handle matching packets. * Currently, you can only specify the internet gateway, using a full or * partial valid URL: * * `https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway` * * `projects/project/global/gateways/default-internet-gateway` * * `global/gateways/default-internet-gateway` * * The string `default-internet-gateway`. */ nextHopGateway?: pulumi.Input; /** * The IP address or URL to a forwarding rule of type * loadBalancingScheme=INTERNAL that should handle matching * packets. * With the GA provider you can only specify the forwarding * rule as a partial or full URL. For example, the following * are all valid values: * * 10.128.0.56 * * https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule * * regions/region/forwardingRules/forwardingRule * When the beta provider, you can also specify the IP address * of a forwarding rule from the same VPC or any peered VPC. * Note that this can only be used when the destinationRange is * a public (non-RFC 1918) IP CIDR range. */ nextHopIlb?: pulumi.Input; /** * 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/instance` * * `projects/project/zones/zone/instances/instance` * * `zones/zone/instances/instance` * * Just the instance name, with the zone in `nextHopInstanceZone`. */ nextHopInstance?: pulumi.Input; /** * (Optional when `nextHopInstance` is * specified) The zone of the instance specified in * `nextHopInstance`. Omit if `nextHopInstance` is specified as * a URL. */ nextHopInstanceZone?: pulumi.Input; /** * Network IP address of an instance that should handle matching packets. */ nextHopIp?: pulumi.Input; /** * URL to a VpnTunnel that should handle matching packets. */ nextHopVpnTunnel?: pulumi.Input; /** * Additional params passed with the request, but not persisted as part of resource payload * Structure is documented below. */ params?: pulumi.Input; /** * 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 the case of two routes with equal prefix length, the one with the * lowest-numbered priority value wins. * Default value is 1000. Valid range is 0 through 65535. */ priority?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * A list of instance tags to which this route applies. */ tags?: pulumi.Input[] | undefined>; } //# sourceMappingURL=route.d.ts.map