ForwardingRuleArgs class

The set of arguments for ForwardingRule. The set of arguments for ForwardingRule.

Constructors

ForwardingRuleArgs({Input<bool?>? allPorts, Input<bool?>? allowGlobalAccess, Input<bool?>? allowPscGlobalAccess, Input<String?>? backendService, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? ipAddress, Input<String?>? ipCollection, Input<String?>? ipProtocol, Input<String?>? ipVersion, Input<bool?>? isMirroringCollector, Input<Map<String, String>?>? labels, Input<String?>? loadBalancingScheme, Input<String?>? name, Input<String?>? network, Input<String?>? networkTier, Input<bool?>? noAutomateDnsZone, Input<String?>? portRange, Input<List<String>?>? ports, Input<String?>? project, Input<bool?>? recreateClosedPsc, Input<String?>? region, Input<ForwardingRuleServiceDirectoryRegistrations?>? serviceDirectoryRegistrations, Input<String?>? serviceLabel, Input<List<String>?>? sourceIpRanges, Input<String?>? subnetwork, Input<String?>? target})

Creates a new ForwardingRuleArgs. allPorts The ports, portRange, and allPorts fields are mutually exclusive. allowGlobalAccess This field is used along with the backendService field for allowPscGlobalAccess This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. backendService Identifies the backend service to which the forwarding rule sends traffic. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description An optional description of this resource. Provide this property when ipAddress IP address for which this forwarding rule accepts traffic. When a client ipCollection Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP ipProtocol The IP protocol to which this rule applies. ipVersion The IP address version that will be used by this forwarding rule. isMirroringCollector Indicates whether or not this load balancer can be used as a collector for labels Labels to apply to this forwarding rule. A list of key->value pairs. loadBalancingScheme Specifies the forwarding rule type. name Name of the resource; provided by the client when the resource is created. network This field is not used for external load balancing. networkTier This signifies the networking tier used for configuring noAutomateDnsZone 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 The ports, portRange, and allPorts fields are mutually exclusive. ports The ports, portRange, and allPorts fields are mutually exclusive. project The ID of the project in which the resource belongs. recreateClosedPsc This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed region A reference to the region where the regional forwarding rule resides. serviceDirectoryRegistrations Service Directory resources to register this forwarding rule with. serviceLabel An optional prefix to the service name for this Forwarding Rule. sourceIpRanges 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 This field identifies the subnetwork that the load balanced IP should target The URL of the target resource to receive the matched traffic. For

const

ForwardingRuleArgs.fromMap(Map<String, dynamic> map)

factory

Properties

allowGlobalAccess → Input<bool?>?

This field is used along with the backendService 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.

final

allowPscGlobalAccess → Input<bool?>?

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

final

allPorts → Input<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:

final

backendService → Input<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.

final

deletionPolicy → Input<String?>?

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

final

description → Input<String?>?

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

final

hashCode → int

The hash code for this object.

no setter, inherited

ipAddress → Input<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:

final

ipCollection → Input<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:

final

ipProtocol → Input<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 are: TCP, UDP, ESP, AH, SCTP, ICMP, L3_DEFAULT.

final

ipVersion → Input<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 are: IPV4, IPV6.

final

isMirroringCollector → Input<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.

final

labels → Input<Map<String, String>?>?

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

final

loadBalancingScheme → Input<String?>?

Specifies the forwarding rule type. Note that an empty string value ("") is also supported for some use cases, for example PSC (private service connection) regional forwarding rules. For more information about forwarding rules, refer to Forwarding rule concepts. Default value is EXTERNAL. Possible values are: EXTERNAL, EXTERNAL_MANAGED, INTERNAL, INTERNAL_MANAGED.

final

name → Input<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.

final

network → Input<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.

final

networkTier → Input<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 are: PREMIUM, STANDARD.

final

noAutomateDnsZone → Input<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.

final

portRange → Input<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:

final

ports → Input<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:

final

project → Input<String?>?

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

final

recreateClosedPsc → Input<bool?>?

This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed

final

region → Input<String?>?

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceDirectoryRegistrations → Input<ForwardingRuleServiceDirectoryRegistrations?>?

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. Structure is documented below.

final

serviceLabel → Input<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.

final

sourceIpRanges → Input<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).

final

subnetwork → Input<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.

final

target → Input<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.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited