Class ForwardingRuleArgs

Inheritance

System.Object

InputArgs

ResourceArgs

ForwardingRuleArgs

Inherited Members

ResourceArgs.Empty

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 sealed class ForwardingRuleArgs : ResourceArgs

Constructors

View Source

ForwardingRuleArgs()

Declaration

public ForwardingRuleArgs()

Properties

View Source

AllowGlobalAccess

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

Declaration

public Input<bool> AllowGlobalAccess { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

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 Input<bool> AllPorts { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

BackendService

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

Declaration

public Input<string> BackendService { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

Description

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

Declaration

public Input<string> Description { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

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 Input<string> IpAddress { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

IpProtocol

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

Declaration

public Input<string> IpProtocol { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

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 Input<bool> IsMirroringCollector { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

Labels

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

Declaration

public InputMap<string> Labels { get; set; }

Property Value

Type	Description
InputMap<System.String>

View Source

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 Input<string> LoadBalancingScheme { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

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 Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

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 Input<string> Network { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

NetworkTier

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

Declaration

public Input<string> NetworkTier { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

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 Input<string> PortRange { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

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 InputList<string> Ports { get; set; }

Property Value

Type	Description
InputList<System.String>

View Source

Project

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

Declaration

public Input<string> Project { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

Region

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

Declaration

public Input<string> Region { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

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 Input<string> ServiceLabel { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

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 Input<string> Subnetwork { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

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 Input<string> Target { get; set; }

Property Value

Type	Description
Input<System.String>