Class ForwardingRule

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.

To get more information about ForwardingRule, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage - Forwarding Rule Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var defaultTargetPool = new Gcp.Compute.TargetPool("defaultTargetPool", new Gcp.Compute.TargetPoolArgs
    {
    });
    var defaultForwardingRule = new Gcp.Compute.ForwardingRule("defaultForwardingRule", new Gcp.Compute.ForwardingRuleArgs
    {
        Target = defaultTargetPool.Id,
        PortRange = "80",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ForwardingRule

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Compute

Assembly: Pulumi.Gcp.dll

Syntax

public class ForwardingRule : CustomResource

Constructors

ForwardingRule(String, ForwardingRuleArgs, CustomResourceOptions)

Create a ForwardingRule resource with the given unique name, arguments, and options.

Declaration

public ForwardingRule(string name, ForwardingRuleArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ForwardingRuleArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AllowGlobalAccess

If true, clients can access ILB from all regions. Otherwise only allows from the local region the ILB is located at.

Declaration

public Output<bool?> AllowGlobalAccess { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

AllPorts

For internal TCP/UDP load balancing (i.e. load balancing scheme is INTERNAL and protocol is TCP/UDP), set this to true to allow packets addressed to any ports to be forwarded to the backends configured with this forwarding rule. Used with backend service. Cannot be set if port or portRange are set.

Declaration

public Output<bool?> AllPorts { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

BackendService

A BackendService to receive the matched traffic. This is used only for INTERNAL load balancing.

Declaration

public Output<string> BackendService { get; }

Property Value

Type	Description
Output<System.String>

CreationTimestamp

Creation timestamp in RFC3339 text format.

Declaration

public Output<string> CreationTimestamp { get; }

Property Value

Type	Description
Output<System.String>

Description

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

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

IpAddress

The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address must be specified by a literal IP address. > NOTE: While the API allows you to specify various resource paths for an address resource instead, this provider requires this to specifically be an IP address to avoid needing to fetching the IP address from resource paths on refresh or unnecessary diffs.

Declaration

public Output<string> IpAddress { get; }

Property Value

Type	Description
Output<System.String>

IpProtocol

The IP protocol to which this rule applies. When the load balancing scheme is INTERNAL, only TCP and UDP are valid.

Declaration

public Output<string> IpProtocol { get; }

Property Value

Type	Description
Output<System.String>

IsMirroringCollector

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.

Declaration

public Output<bool?> IsMirroringCollector { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

LabelFingerprint

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

Declaration

public Output<string> LabelFingerprint { get; }

Property Value

Type	Description
Output<System.String>

Labels

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

Declaration

public Output<ImmutableDictionary<string, string>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

LoadBalancingScheme

This signifies what the ForwardingRule will be used for and can be EXTERNAL, INTERNAL, or INTERNAL_MANAGED. EXTERNAL is used for Classic Cloud VPN gateways, protocol forwarding to VMs from an external IP address, and HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP load balancers. INTERNAL is used for protocol forwarding to VMs from an internal IP address, and internal TCP/UDP load balancers. INTERNAL_MANAGED is used for internal HTTP(S) load balancers.

Declaration

public Output<string> LoadBalancingScheme { get; }

Property Value

Type	Description
Output<System.String>

Name

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.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Network

For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. This field is only used for INTERNAL load balancing.

Declaration

public Output<string> Network { get; }

Property Value

Type	Description
Output<System.String>

NetworkTier

The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM.

Declaration

public Output<string> NetworkTier { get; }

Property Value

Type	Description
Output<System.String>

PortRange

This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports:

• TargetHttpProxy: 80, 8080
• TargetHttpsProxy: 443
• TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222
• TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222
• TargetVpnGateway: 500, 4500

Declaration

public Output<string> PortRange { get; }

Property Value

Type	Description
Output<System.String>

Ports

This field is used along with the backend_service field for internal load balancing. When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. You may specify a maximum of up to 5 ports.

Declaration

public Output<ImmutableArray<string>> Ports { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

Region

A reference to the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

SelfLink

The URI of the created resource.

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

ServiceLabel

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.

Declaration

public Output<string> ServiceLabel { get; }

Property Value

Type	Description
Output<System.String>

ServiceName

The internal fully qualified service name for this Forwarding Rule. This field is only used for INTERNAL load balancing.

Declaration

public Output<string> ServiceName { get; }

Property Value

Type	Description
Output<System.String>

Subnetwork

The subnetwork that the load balanced IP should belong to for this Forwarding Rule. This field is only used for INTERNAL load balancing. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.

Declaration

public Output<string> Subnetwork { get; }

Property Value

Type	Description
Output<System.String>

Target

The URL of the target resource to receive the matched traffic. The target must live in the same region as the forwarding rule. The forwarded traffic must be of a type appropriate to the target object.

Declaration

public Output<string> Target { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ForwardingRuleState, CustomResourceOptions)

Get an existing ForwardingRule resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ForwardingRule Get(string name, Input<string> id, ForwardingRuleState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ForwardingRuleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ForwardingRule