Google Cloud v8.21.0, Mar 5 25

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

gcp.compute.getForwardingRules

Explore with Pulumi AI

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const my_forwarding_rules = gcp.compute.getForwardingRules({
    project: "my-cloud-project",
    region: "us-central1",
});

import pulumi
import pulumi_gcp as gcp

my_forwarding_rules = gcp.compute.get_forwarding_rules(project="my-cloud-project",
    region="us-central1")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.GetForwardingRules(ctx, &compute.GetForwardingRulesArgs{
			Project: pulumi.StringRef("my-cloud-project"),
			Region:  pulumi.StringRef("us-central1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var my_forwarding_rules = Gcp.Compute.GetForwardingRules.Invoke(new()
    {
        Project = "my-cloud-project",
        Region = "us-central1",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetForwardingRulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var my-forwarding-rules = ComputeFunctions.getForwardingRules(GetForwardingRulesArgs.builder()
            .project("my-cloud-project")
            .region("us-central1")
            .build());

    }
}

variables:
  my-forwarding-rules:
    fn::invoke:
      function: gcp:compute:getForwardingRules
      arguments:
        project: my-cloud-project
        region: us-central1

Using getForwardingRules

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getForwardingRules(args: GetForwardingRulesArgs, opts?: InvokeOptions): Promise<GetForwardingRulesResult>
function getForwardingRulesOutput(args: GetForwardingRulesOutputArgs, opts?: InvokeOptions): Output<GetForwardingRulesResult>

def get_forwarding_rules(project: Optional[str] = None,
                         region: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetForwardingRulesResult
def get_forwarding_rules_output(project: Optional[pulumi.Input[str]] = None,
                         region: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetForwardingRulesResult]

func GetForwardingRules(ctx *Context, args *GetForwardingRulesArgs, opts ...InvokeOption) (*GetForwardingRulesResult, error)
func GetForwardingRulesOutput(ctx *Context, args *GetForwardingRulesOutputArgs, opts ...InvokeOption) GetForwardingRulesResultOutput

> Note: This function is named GetForwardingRules in the Go SDK.

public static class GetForwardingRules 
{
    public static Task<GetForwardingRulesResult> InvokeAsync(GetForwardingRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetForwardingRulesResult> Invoke(GetForwardingRulesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetForwardingRulesResult> getForwardingRules(GetForwardingRulesArgs args, InvokeOptions options)
public static Output<GetForwardingRulesResult> getForwardingRules(GetForwardingRulesArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:compute/getForwardingRules:getForwardingRules
  arguments:
    # arguments dictionary

The following arguments are supported:

Project string

The name of the project.

Region string

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

Project string

The name of the project.

Region string

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

project String

The name of the project.

region String

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

project string

The name of the project.

region string

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

project str

The name of the project.

region str

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

project String

The name of the project.

region String

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

getForwardingRules Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Rules List<GetForwardingRulesRule>: This is a list of the forwarding rules in the project. Each forwarding rule will list the backend, description, ip address. name, network, self link, service label, service name, and subnet.
Project string: The project name being queried.
Region string: The region being queried.

Id string: The provider-assigned unique ID for this managed resource.
Rules []GetForwardingRulesRule: This is a list of the forwarding rules in the project. Each forwarding rule will list the backend, description, ip address. name, network, self link, service label, service name, and subnet.
Project string: The project name being queried.
Region string: The region being queried.

id String: The provider-assigned unique ID for this managed resource.
rules List<GetForwardingRulesRule>: This is a list of the forwarding rules in the project. Each forwarding rule will list the backend, description, ip address. name, network, self link, service label, service name, and subnet.
project String: The project name being queried.
region String: The region being queried.

id string: The provider-assigned unique ID for this managed resource.
rules GetForwardingRulesRule[]: This is a list of the forwarding rules in the project. Each forwarding rule will list the backend, description, ip address. name, network, self link, service label, service name, and subnet.
project string: The project name being queried.
region string: The region being queried.

id str: The provider-assigned unique ID for this managed resource.
rules Sequence[GetForwardingRulesRule]: This is a list of the forwarding rules in the project. Each forwarding rule will list the backend, description, ip address. name, network, self link, service label, service name, and subnet.
project str: The project name being queried.
region str: The region being queried.

id String: The provider-assigned unique ID for this managed resource.
rules List<Property Map>: This is a list of the forwarding rules in the project. Each forwarding rule will list the backend, description, ip address. name, network, self link, service label, service name, and subnet.
project String: The project name being queried.
region String: The region being queried.

Supporting Types

GetForwardingRulesRule

AllPorts bool

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'allPorts' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, SCTP, or L3_DEFAULT.
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires 'allPorts' be set to true.

AllowGlobalAccess bool

This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.

If the field is set to 'TRUE', clients can access ILB from all regions.

Otherwise only allows access from clients in the same region as the internal load balancer.

AllowPscGlobalAccess bool

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

BackendService string

Identifies the backend service to which the forwarding rule sends traffic.

Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

BaseForwardingRule string

[Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified.

CreationTimestamp string

Creation timestamp in RFC3339 text format.

Description string

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

EffectiveLabels Dictionary<string, string>

ForwardingRuleId int

The unique identifier number for the resource. This identifier is defined by the server.

IpAddress string

IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced 'target' or 'backendService'.

While creating a forwarding rule, specifying an 'IPAddress' is required under the following circumstances:

When the 'target' is set to 'targetGrpcProxy' and 'validateForProxyless' is set to 'true', the 'IPAddress' should be set to '0.0.0.0'.
When the 'target' is a Private Service Connect Google APIs bundle, you must specify an 'IPAddress'.

Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.

Use one of the following formats to specify an IP address while creating a forwarding rule:

IP address number, as in '100.1.2.3'
IPv6 address range, as in '2600:1234::/96'
Full resource URL, as in 'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name'
Partial URL or by name, as in:
- 'projects/project_id/regions/region/addresses/address-name'
- 'regions/region/addresses/address-name'
- 'global/addresses/address-name'
- 'address-name'

The forwarding rule's 'target' or 'backendService', and in most cases, also the 'loadBalancingScheme', determine the type of IP address that you can use. For detailed information, see IP address specifications.

When reading an 'IPAddress', the API always returns the IP address number.

IpCollection string

Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in:

'https://www.googleapis.com/compute/v1/projects/{{projectId}}/regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}' Partial URL, as in:
'projects/{{projectId}}/regions/region/publicDelegatedPrefixes/{{sub-pdp-name}}'
'regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}'

IpProtocol string

The IP protocol to which this rule applies.

For protocol forwarding, valid options are 'TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP' and 'L3_DEFAULT'.

The valid IP protocols are different for different load balancing products as described in Load balancing features.

A Forwarding Rule with protocol L3_DEFAULT can attach with target instance or backend service with UNSPECIFIED protocol. A forwarding rule with "L3_DEFAULT" IPProtocal cannot be attached to a backend service with TCP or UDP. Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP", "L3_DEFAULT"]

IpVersion string

The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.

If not set, the IPv4 address will be used by default. Possible values: ["IPV4", "IPV6"]

IsMirroringCollector bool

Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a 'PacketMirroring' rule applies to them.

This can only be set to true for load balancers that have their 'loadBalancingScheme' set to 'INTERNAL'.

LabelFingerprint string

The fingerprint used for optimistic locking of this resource. Used internally during updates.

Labels Dictionary<string, string>

Labels to apply to this forwarding rule. A list of key->value pairs.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

LoadBalancingScheme string

Specifies the forwarding rule type.

For more information about forwarding rules, refer to Forwarding rule concepts. Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]

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?' 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.

For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.

Network string

This field is not used for external load balancing.

For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used.

For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

NetworkTier string

This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.

For regional ForwardingRule, the valid values are 'PREMIUM' and 'STANDARD'. For GlobalForwardingRule, the valid value is 'PREMIUM'.

If this field is not specified, it is assumed to be 'PREMIUM'. If 'IPAddress' is specified, this value must be equal to the networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"]

NoAutomateDnsZone bool

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.

PortRange string

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'portRange' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
Some products have restrictions on what ports can be used. See port specifications for details.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

@pattern: \d+(?:-\d+)?

Ports List<string>

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'ports' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

@pattern: \d+(?:-\d+)?

Project string

The name of the project.

PscConnectionId string

The PSC connection id of the PSC Forwarding Rule.

PscConnectionStatus string

The PSC connection status of the PSC Forwarding Rule. Possible values: 'STATUS_UNSPECIFIED', 'PENDING', 'ACCEPTED', 'REJECTED', 'CLOSED'

PulumiLabels Dictionary<string, string>

The combination of labels configured directly on the resource and default labels configured on the provider.

RecreateClosedPsc bool

Region string

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

SelfLink string

The URI of the resource.

ServiceDirectoryRegistrations List<GetForwardingRulesRuleServiceDirectoryRegistration>

Service Directory resources to register this forwarding rule with.

Currently, only supports a single Service Directory resource.

ServiceLabel string

An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name.

The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label 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.

This field is only used for INTERNAL load balancing.

ServiceName string

The internal fully qualified service name for this Forwarding Rule.

This field is only used for INTERNAL load balancing.

SourceIpRanges List<string>

If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).

Subnetwork string

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.

If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.

Target string

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource.

The forwarded traffic must be of a type appropriate to the target object.

For load balancers, see the "Target" column in Port specifications.
For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
'vpc-sc' - APIs that support VPC Service Controls.
'all-apis' - All supported Google APIs.

For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.

AllPorts bool

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'allPorts' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, SCTP, or L3_DEFAULT.
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires 'allPorts' be set to true.

AllowGlobalAccess bool

This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.

If the field is set to 'TRUE', clients can access ILB from all regions.

Otherwise only allows access from clients in the same region as the internal load balancer.

AllowPscGlobalAccess bool

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

BackendService string

Identifies the backend service to which the forwarding rule sends traffic.

Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

BaseForwardingRule string

CreationTimestamp string

Creation timestamp in RFC3339 text format.

Description string

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

EffectiveLabels map[string]string

ForwardingRuleId int

The unique identifier number for the resource. This identifier is defined by the server.

IpAddress string

IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced 'target' or 'backendService'.

While creating a forwarding rule, specifying an 'IPAddress' is required under the following circumstances:

When the 'target' is set to 'targetGrpcProxy' and 'validateForProxyless' is set to 'true', the 'IPAddress' should be set to '0.0.0.0'.
When the 'target' is a Private Service Connect Google APIs bundle, you must specify an 'IPAddress'.

Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.

Use one of the following formats to specify an IP address while creating a forwarding rule:

IP address number, as in '100.1.2.3'
IPv6 address range, as in '2600:1234::/96'
Full resource URL, as in 'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name'
Partial URL or by name, as in:
- 'projects/project_id/regions/region/addresses/address-name'
- 'regions/region/addresses/address-name'
- 'global/addresses/address-name'
- 'address-name'

When reading an 'IPAddress', the API always returns the IP address number.

IpCollection string

'https://www.googleapis.com/compute/v1/projects/{{projectId}}/regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}' Partial URL, as in:
'projects/{{projectId}}/regions/region/publicDelegatedPrefixes/{{sub-pdp-name}}'
'regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}'

IpProtocol string

The IP protocol to which this rule applies.

For protocol forwarding, valid options are 'TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP' and 'L3_DEFAULT'.

The valid IP protocols are different for different load balancing products as described in Load balancing features.

IpVersion string

The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.

If not set, the IPv4 address will be used by default. Possible values: ["IPV4", "IPV6"]

IsMirroringCollector bool

This can only be set to true for load balancers that have their 'loadBalancingScheme' set to 'INTERNAL'.

LabelFingerprint string

The fingerprint used for optimistic locking of this resource. Used internally during updates.

Labels map[string]string

Labels to apply to this forwarding rule. A list of key->value pairs.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

LoadBalancingScheme string

Specifies the forwarding rule type.

For more information about forwarding rules, refer to Forwarding rule concepts. Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]

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.

Network string

This field is not used for external load balancing.

For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

NetworkTier string

This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.

For regional ForwardingRule, the valid values are 'PREMIUM' and 'STANDARD'. For GlobalForwardingRule, the valid value is 'PREMIUM'.

If this field is not specified, it is assumed to be 'PREMIUM'. If 'IPAddress' is specified, this value must be equal to the networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"]

NoAutomateDnsZone bool

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.

PortRange string

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'portRange' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
Some products have restrictions on what ports can be used. See port specifications for details.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

@pattern: \d+(?:-\d+)?

Ports []string

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'ports' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

@pattern: \d+(?:-\d+)?

Project string

The name of the project.

PscConnectionId string

The PSC connection id of the PSC Forwarding Rule.

PscConnectionStatus string

The PSC connection status of the PSC Forwarding Rule. Possible values: 'STATUS_UNSPECIFIED', 'PENDING', 'ACCEPTED', 'REJECTED', 'CLOSED'

PulumiLabels map[string]string

The combination of labels configured directly on the resource and default labels configured on the provider.

RecreateClosedPsc bool

Region string

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

SelfLink string

The URI of the resource.

ServiceDirectoryRegistrations []GetForwardingRulesRuleServiceDirectoryRegistration

Service Directory resources to register this forwarding rule with.

Currently, only supports a single Service Directory resource.

ServiceLabel string

An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name.

This field is only used for INTERNAL load balancing.

ServiceName string

The internal fully qualified service name for this Forwarding Rule.

This field is only used for INTERNAL load balancing.

SourceIpRanges []string

Subnetwork string

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.

Target string

The forwarded traffic must be of a type appropriate to the target object.

For load balancers, see the "Target" column in Port specifications.
For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
'vpc-sc' - APIs that support VPC Service Controls.
'all-apis' - All supported Google APIs.

For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.

allPorts Boolean

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'allPorts' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, SCTP, or L3_DEFAULT.
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires 'allPorts' be set to true.

allowGlobalAccess Boolean

This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.

If the field is set to 'TRUE', clients can access ILB from all regions.

Otherwise only allows access from clients in the same region as the internal load balancer.

allowPscGlobalAccess Boolean

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

backendService String

Identifies the backend service to which the forwarding rule sends traffic.

Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

baseForwardingRule String

creationTimestamp String

Creation timestamp in RFC3339 text format.

description String

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

effectiveLabels Map<String,String>

forwardingRuleId Integer

The unique identifier number for the resource. This identifier is defined by the server.

ipAddress String

IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced 'target' or 'backendService'.

While creating a forwarding rule, specifying an 'IPAddress' is required under the following circumstances:

When the 'target' is set to 'targetGrpcProxy' and 'validateForProxyless' is set to 'true', the 'IPAddress' should be set to '0.0.0.0'.
When the 'target' is a Private Service Connect Google APIs bundle, you must specify an 'IPAddress'.

Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.

Use one of the following formats to specify an IP address while creating a forwarding rule:

IP address number, as in '100.1.2.3'
IPv6 address range, as in '2600:1234::/96'
Full resource URL, as in 'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name'
Partial URL or by name, as in:
- 'projects/project_id/regions/region/addresses/address-name'
- 'regions/region/addresses/address-name'
- 'global/addresses/address-name'
- 'address-name'

When reading an 'IPAddress', the API always returns the IP address number.

ipCollection String

'https://www.googleapis.com/compute/v1/projects/{{projectId}}/regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}' Partial URL, as in:
'projects/{{projectId}}/regions/region/publicDelegatedPrefixes/{{sub-pdp-name}}'
'regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}'

ipProtocol String

The IP protocol to which this rule applies.

For protocol forwarding, valid options are 'TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP' and 'L3_DEFAULT'.

The valid IP protocols are different for different load balancing products as described in Load balancing features.

ipVersion String

The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.

If not set, the IPv4 address will be used by default. Possible values: ["IPV4", "IPV6"]

isMirroringCollector Boolean

This can only be set to true for load balancers that have their 'loadBalancingScheme' set to 'INTERNAL'.

labelFingerprint String

The fingerprint used for optimistic locking of this resource. Used internally during updates.

labels Map<String,String>

Labels to apply to this forwarding rule. A list of key->value pairs.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

loadBalancingScheme String

Specifies the forwarding rule type.

For more information about forwarding rules, refer to Forwarding rule concepts. Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]

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.

network String

This field is not used for external load balancing.

For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

networkTier String

This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.

For regional ForwardingRule, the valid values are 'PREMIUM' and 'STANDARD'. For GlobalForwardingRule, the valid value is 'PREMIUM'.

If this field is not specified, it is assumed to be 'PREMIUM'. If 'IPAddress' is specified, this value must be equal to the networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"]

noAutomateDnsZone Boolean

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.

portRange String

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'portRange' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
Some products have restrictions on what ports can be used. See port specifications for details.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

@pattern: \d+(?:-\d+)?

ports List<String>

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'ports' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

@pattern: \d+(?:-\d+)?

project String

The name of the project.

pscConnectionId String

The PSC connection id of the PSC Forwarding Rule.

pscConnectionStatus String

The PSC connection status of the PSC Forwarding Rule. Possible values: 'STATUS_UNSPECIFIED', 'PENDING', 'ACCEPTED', 'REJECTED', 'CLOSED'

pulumiLabels Map<String,String>

The combination of labels configured directly on the resource and default labels configured on the provider.

recreateClosedPsc Boolean

region String

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

selfLink String

The URI of the resource.

serviceDirectoryRegistrations List<GetForwardingRulesRuleServiceDirectoryRegistration>

Service Directory resources to register this forwarding rule with.

Currently, only supports a single Service Directory resource.

serviceLabel String

An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name.

This field is only used for INTERNAL load balancing.

serviceName String

The internal fully qualified service name for this Forwarding Rule.

This field is only used for INTERNAL load balancing.

sourceIpRanges List<String>

subnetwork String

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.

target String

The forwarded traffic must be of a type appropriate to the target object.

For load balancers, see the "Target" column in Port specifications.
For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
'vpc-sc' - APIs that support VPC Service Controls.
'all-apis' - All supported Google APIs.

For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.

allPorts boolean

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'allPorts' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, SCTP, or L3_DEFAULT.
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires 'allPorts' be set to true.

allowGlobalAccess boolean

This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.

If the field is set to 'TRUE', clients can access ILB from all regions.

Otherwise only allows access from clients in the same region as the internal load balancer.

allowPscGlobalAccess boolean

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

backendService string

Identifies the backend service to which the forwarding rule sends traffic.

Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

baseForwardingRule string

creationTimestamp string

Creation timestamp in RFC3339 text format.

description string

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

effectiveLabels {[key: string]: string}

forwardingRuleId number

The unique identifier number for the resource. This identifier is defined by the server.

ipAddress string

IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced 'target' or 'backendService'.

While creating a forwarding rule, specifying an 'IPAddress' is required under the following circumstances:

When the 'target' is set to 'targetGrpcProxy' and 'validateForProxyless' is set to 'true', the 'IPAddress' should be set to '0.0.0.0'.
When the 'target' is a Private Service Connect Google APIs bundle, you must specify an 'IPAddress'.

Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.

Use one of the following formats to specify an IP address while creating a forwarding rule:

IP address number, as in '100.1.2.3'
IPv6 address range, as in '2600:1234::/96'
Full resource URL, as in 'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name'
Partial URL or by name, as in:
- 'projects/project_id/regions/region/addresses/address-name'
- 'regions/region/addresses/address-name'
- 'global/addresses/address-name'
- 'address-name'

When reading an 'IPAddress', the API always returns the IP address number.

ipCollection string

'https://www.googleapis.com/compute/v1/projects/{{projectId}}/regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}' Partial URL, as in:
'projects/{{projectId}}/regions/region/publicDelegatedPrefixes/{{sub-pdp-name}}'
'regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}'

ipProtocol string

The IP protocol to which this rule applies.

For protocol forwarding, valid options are 'TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP' and 'L3_DEFAULT'.

The valid IP protocols are different for different load balancing products as described in Load balancing features.

ipVersion string

The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.

If not set, the IPv4 address will be used by default. Possible values: ["IPV4", "IPV6"]

isMirroringCollector boolean

This can only be set to true for load balancers that have their 'loadBalancingScheme' set to 'INTERNAL'.

labelFingerprint string

The fingerprint used for optimistic locking of this resource. Used internally during updates.

labels {[key: string]: string}

Labels to apply to this forwarding rule. A list of key->value pairs.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

loadBalancingScheme string

Specifies the forwarding rule type.

For more information about forwarding rules, refer to Forwarding rule concepts. Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]

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.

network string

This field is not used for external load balancing.

For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

networkTier string

This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.

For regional ForwardingRule, the valid values are 'PREMIUM' and 'STANDARD'. For GlobalForwardingRule, the valid value is 'PREMIUM'.

If this field is not specified, it is assumed to be 'PREMIUM'. If 'IPAddress' is specified, this value must be equal to the networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"]

noAutomateDnsZone boolean

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.

portRange string

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'portRange' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
Some products have restrictions on what ports can be used. See port specifications for details.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

@pattern: \d+(?:-\d+)?

ports string[]

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'ports' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

@pattern: \d+(?:-\d+)?

project string

The name of the project.

pscConnectionId string

The PSC connection id of the PSC Forwarding Rule.

pscConnectionStatus string

The PSC connection status of the PSC Forwarding Rule. Possible values: 'STATUS_UNSPECIFIED', 'PENDING', 'ACCEPTED', 'REJECTED', 'CLOSED'

pulumiLabels {[key: string]: string}

The combination of labels configured directly on the resource and default labels configured on the provider.

recreateClosedPsc boolean

region string

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

selfLink string

The URI of the resource.

serviceDirectoryRegistrations GetForwardingRulesRuleServiceDirectoryRegistration[]

Service Directory resources to register this forwarding rule with.

Currently, only supports a single Service Directory resource.

serviceLabel string

An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name.

This field is only used for INTERNAL load balancing.

serviceName string

The internal fully qualified service name for this Forwarding Rule.

This field is only used for INTERNAL load balancing.

sourceIpRanges string[]

subnetwork string

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.

target string

The forwarded traffic must be of a type appropriate to the target object.

For load balancers, see the "Target" column in Port specifications.
For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
'vpc-sc' - APIs that support VPC Service Controls.
'all-apis' - All supported Google APIs.

For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.

all_ports bool

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'allPorts' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, SCTP, or L3_DEFAULT.
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires 'allPorts' be set to true.

allow_global_access bool

This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.

If the field is set to 'TRUE', clients can access ILB from all regions.

Otherwise only allows access from clients in the same region as the internal load balancer.

allow_psc_global_access bool

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

backend_service str

Identifies the backend service to which the forwarding rule sends traffic.

Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

base_forwarding_rule str

creation_timestamp str

Creation timestamp in RFC3339 text format.

description str

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

effective_labels Mapping[str, str]

forwarding_rule_id int

The unique identifier number for the resource. This identifier is defined by the server.

ip_address str

IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced 'target' or 'backendService'.

While creating a forwarding rule, specifying an 'IPAddress' is required under the following circumstances:

When the 'target' is set to 'targetGrpcProxy' and 'validateForProxyless' is set to 'true', the 'IPAddress' should be set to '0.0.0.0'.
When the 'target' is a Private Service Connect Google APIs bundle, you must specify an 'IPAddress'.

Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.

Use one of the following formats to specify an IP address while creating a forwarding rule:

IP address number, as in '100.1.2.3'
IPv6 address range, as in '2600:1234::/96'
Full resource URL, as in 'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name'
Partial URL or by name, as in:
- 'projects/project_id/regions/region/addresses/address-name'
- 'regions/region/addresses/address-name'
- 'global/addresses/address-name'
- 'address-name'

When reading an 'IPAddress', the API always returns the IP address number.

ip_collection str

'https://www.googleapis.com/compute/v1/projects/{{projectId}}/regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}' Partial URL, as in:
'projects/{{projectId}}/regions/region/publicDelegatedPrefixes/{{sub-pdp-name}}'
'regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}'

ip_protocol str

The IP protocol to which this rule applies.

For protocol forwarding, valid options are 'TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP' and 'L3_DEFAULT'.

The valid IP protocols are different for different load balancing products as described in Load balancing features.

ip_version str

The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.

If not set, the IPv4 address will be used by default. Possible values: ["IPV4", "IPV6"]

is_mirroring_collector bool

This can only be set to true for load balancers that have their 'loadBalancingScheme' set to 'INTERNAL'.

label_fingerprint str

The fingerprint used for optimistic locking of this resource. Used internally during updates.

labels Mapping[str, str]

Labels to apply to this forwarding rule. A list of key->value pairs.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

load_balancing_scheme str

Specifies the forwarding rule type.

For more information about forwarding rules, refer to Forwarding rule concepts. Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]

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.

network str

This field is not used for external load balancing.

For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

network_tier str

This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.

For regional ForwardingRule, the valid values are 'PREMIUM' and 'STANDARD'. For GlobalForwardingRule, the valid value is 'PREMIUM'.

If this field is not specified, it is assumed to be 'PREMIUM'. If 'IPAddress' is specified, this value must be equal to the networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"]

no_automate_dns_zone bool

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.

port_range str

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'portRange' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
Some products have restrictions on what ports can be used. See port specifications for details.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

@pattern: \d+(?:-\d+)?

ports Sequence[str]

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'ports' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

@pattern: \d+(?:-\d+)?

project str

The name of the project.

psc_connection_id str

The PSC connection id of the PSC Forwarding Rule.

psc_connection_status str

The PSC connection status of the PSC Forwarding Rule. Possible values: 'STATUS_UNSPECIFIED', 'PENDING', 'ACCEPTED', 'REJECTED', 'CLOSED'

pulumi_labels Mapping[str, str]

The combination of labels configured directly on the resource and default labels configured on the provider.

recreate_closed_psc bool

region str

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

self_link str

The URI of the resource.

service_directory_registrations Sequence[GetForwardingRulesRuleServiceDirectoryRegistration]

Service Directory resources to register this forwarding rule with.

Currently, only supports a single Service Directory resource.

service_label str

An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name.

This field is only used for INTERNAL load balancing.

service_name str

The internal fully qualified service name for this Forwarding Rule.

This field is only used for INTERNAL load balancing.

source_ip_ranges Sequence[str]

subnetwork str

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.

target str

The forwarded traffic must be of a type appropriate to the target object.

For load balancers, see the "Target" column in Port specifications.
For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
'vpc-sc' - APIs that support VPC Service Controls.
'all-apis' - All supported Google APIs.

For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.

allPorts Boolean

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'allPorts' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, SCTP, or L3_DEFAULT.
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires 'allPorts' be set to true.

allowGlobalAccess Boolean

This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.

If the field is set to 'TRUE', clients can access ILB from all regions.

Otherwise only allows access from clients in the same region as the internal load balancer.

allowPscGlobalAccess Boolean

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

backendService String

Identifies the backend service to which the forwarding rule sends traffic.

Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.

baseForwardingRule String

creationTimestamp String

Creation timestamp in RFC3339 text format.

description String

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

effectiveLabels Map<String>

forwardingRuleId Number

The unique identifier number for the resource. This identifier is defined by the server.

ipAddress String

IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced 'target' or 'backendService'.

While creating a forwarding rule, specifying an 'IPAddress' is required under the following circumstances:

When the 'target' is set to 'targetGrpcProxy' and 'validateForProxyless' is set to 'true', the 'IPAddress' should be set to '0.0.0.0'.
When the 'target' is a Private Service Connect Google APIs bundle, you must specify an 'IPAddress'.

Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.

Use one of the following formats to specify an IP address while creating a forwarding rule:

IP address number, as in '100.1.2.3'
IPv6 address range, as in '2600:1234::/96'
Full resource URL, as in 'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name'
Partial URL or by name, as in:
- 'projects/project_id/regions/region/addresses/address-name'
- 'regions/region/addresses/address-name'
- 'global/addresses/address-name'
- 'address-name'

When reading an 'IPAddress', the API always returns the IP address number.

ipCollection String

'https://www.googleapis.com/compute/v1/projects/{{projectId}}/regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}' Partial URL, as in:
'projects/{{projectId}}/regions/region/publicDelegatedPrefixes/{{sub-pdp-name}}'
'regions/{{region}}/publicDelegatedPrefixes/{{sub-pdp-name}}'

ipProtocol String

The IP protocol to which this rule applies.

For protocol forwarding, valid options are 'TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP' and 'L3_DEFAULT'.

The valid IP protocols are different for different load balancing products as described in Load balancing features.

ipVersion String

The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.

If not set, the IPv4 address will be used by default. Possible values: ["IPV4", "IPV6"]

isMirroringCollector Boolean

This can only be set to true for load balancers that have their 'loadBalancingScheme' set to 'INTERNAL'.

labelFingerprint String

The fingerprint used for optimistic locking of this resource. Used internally during updates.

labels Map<String>

Labels to apply to this forwarding rule. A list of key->value pairs.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

loadBalancingScheme String

Specifies the forwarding rule type.

For more information about forwarding rules, refer to Forwarding rule concepts. Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]

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.

network String

This field is not used for external load balancing.

For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.

networkTier String

This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.

For regional ForwardingRule, the valid values are 'PREMIUM' and 'STANDARD'. For GlobalForwardingRule, the valid value is 'PREMIUM'.

If this field is not specified, it is assumed to be 'PREMIUM'. If 'IPAddress' is specified, this value must be equal to the networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"]

noAutomateDnsZone Boolean

This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.

portRange String

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'portRange' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
Some products have restrictions on what ports can be used. See port specifications for details.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.

@pattern: \d+(?:-\d+)?

ports List<String>

The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.

The 'ports' field has the following limitations:

It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.

For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.

@pattern: \d+(?:-\d+)?

project String

The name of the project.

pscConnectionId String

The PSC connection id of the PSC Forwarding Rule.

pscConnectionStatus String

The PSC connection status of the PSC Forwarding Rule. Possible values: 'STATUS_UNSPECIFIED', 'PENDING', 'ACCEPTED', 'REJECTED', 'CLOSED'

pulumiLabels Map<String>

The combination of labels configured directly on the resource and default labels configured on the provider.

recreateClosedPsc Boolean

region String

The region you want to get the forwarding rules from.

These arguments must be set in either the provider or the resource in order for the information to be queried.

selfLink String

The URI of the resource.

serviceDirectoryRegistrations List<Property Map>

Service Directory resources to register this forwarding rule with.

Currently, only supports a single Service Directory resource.

serviceLabel String

An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name.

This field is only used for INTERNAL load balancing.

serviceName String

The internal fully qualified service name for this Forwarding Rule.

This field is only used for INTERNAL load balancing.

sourceIpRanges List<String>

subnetwork String

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.

target String

The forwarded traffic must be of a type appropriate to the target object.

For load balancers, see the "Target" column in Port specifications.
For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
'vpc-sc' - APIs that support VPC Service Controls.
'all-apis' - All supported Google APIs.

For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.

GetForwardingRulesRuleServiceDirectoryRegistration

Namespace string: Service Directory namespace to register the forwarding rule under.
Service string: Service Directory service to register the forwarding rule under.

Namespace string: Service Directory namespace to register the forwarding rule under.
Service string: Service Directory service to register the forwarding rule under.

namespace String: Service Directory namespace to register the forwarding rule under.
service String: Service Directory service to register the forwarding rule under.

namespace string: Service Directory namespace to register the forwarding rule under.
service string: Service Directory service to register the forwarding rule under.

namespace str: Service Directory namespace to register the forwarding rule under.
service str: Service Directory service to register the forwarding rule under.

namespace String: Service Directory namespace to register the forwarding rule under.
service String: Service Directory service to register the forwarding rule under.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.compute.getForwardingRules

On this page

On this page

Example Usage

Using getForwardingRules

getForwardingRules Result

Supporting Types

GetForwardingRulesRule

GetForwardingRulesRuleServiceDirectoryRegistration

Package Details

On this page

On this page