GlobalForwardingRuleState class

Input properties used for looking up and filtering GlobalForwardingRule resources.

Constructors

GlobalForwardingRuleState({Input<bool?>? allowPscGlobalAccess, Input<String?>? baseForwardingRule, Input<String?>? deletionPolicy, Input<String?>? description, Input<Map<String, String>?>? effectiveLabels, Input<String?>? externalManagedBackendBucketMigrationState, Input<double?>? externalManagedBackendBucketMigrationTestingPercentage, Input<int?>? forwardingRuleId, Input<String?>? ipAddress, Input<String?>? ipProtocol, Input<String?>? ipVersion, Input<String?>? labelFingerprint, Input<Map<String, String>?>? labels, Input<String?>? loadBalancingScheme, Input<List<GlobalForwardingRuleMetadataFilter>?>? metadataFilters, Input<String?>? name, Input<String?>? network, Input<String?>? networkTier, Input<bool?>? noAutomateDnsZone, Input<String?>? portRange, Input<String?>? project, Input<String?>? pscConnectionId, Input<String?>? pscConnectionStatus, Input<Map<String, String>?>? pulumiLabels, Input<String?>? selfLink, Input<GlobalForwardingRuleServiceDirectoryRegistrations?>? serviceDirectoryRegistrations, Input<List<String>?>? sourceIpRanges, Input<String?>? subnetwork, Input<String?>? target})

Creates a new GlobalForwardingRuleState. allowPscGlobalAccess (Optional, Beta) baseForwardingRule 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. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description An optional description of this resource. Provide this property when effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. externalManagedBackendBucketMigrationState Specifies the canary migration state for the backend buckets attached to this forwarding rule. externalManagedBackendBucketMigrationTestingPercentage Determines the fraction of requests to backend buckets that should be processed by the Global forwardingRuleId The unique identifier number for the resource. This identifier is defined by the server. ipAddress IP address for which this forwarding rule accepts traffic. When a client ipProtocol The IP protocol to which this rule applies. ipVersion The IP Version that will be used by this global forwarding rule. labelFingerprint The fingerprint used for optimistic locking of this resource. Used labels Labels to apply to this forwarding rule. A list of key->value pairs. loadBalancingScheme Specifies the forwarding rule type. metadataFilters Opaque filter criteria used by Loadbalancer to restrict routing 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 portRange field has the following limitations: project The ID of the project in which the resource belongs. pscConnectionId The PSC connection id of the PSC Forwarding Rule. pscConnectionStatus The PSC connection status of the PSC Forwarding Rule. Possible values: STATUS_UNSPECIFIED, PENDING, ACCEPTED, REJECTED, CLOSED pulumiLabels The combination of labels configured directly on the resource selfLink The URI of the created resource. serviceDirectoryRegistrations Service Directory resources to register this forwarding rule with. 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

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

factory

Properties

allowPscGlobalAccess → Input<bool?>?

(Optional, Beta) This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

final

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

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

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

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

final

externalManagedBackendBucketMigrationState → Input<String?>?

Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Possible values are: PREPARE, TEST_BY_PERCENTAGE, TEST_ALL_TRAFFIC.

final

externalManagedBackendBucketMigrationTestingPercentage → Input<double?>?

Determines the fraction of requests to backend buckets that should be processed by the Global external Application Load Balancer. The value of this field must be in the range 0, 100. This value can only be set if the loadBalancingScheme in the forwarding rule is set to EXTERNAL (when using the Classic ALB) and the migration state is TEST_BY_PERCENTAGE.

final

forwardingRuleId → Input<int?>?

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

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. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances:

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. Possible values are: TCP, UDP, ESP, AH, SCTP, ICMP.

final

ipVersion → Input<String?>?

The IP Version that will be used by this global forwarding rule. Possible values are: IPV4, IPV6.

final

labelFingerprint → Input<String?>?

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

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. For more information about forwarding rules, refer to Forwarding rule concepts. Default value is EXTERNAL. Possible values are: EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED, INTERNAL_SELF_MANAGED.

final

metadataFilters → Input<List<GlobalForwardingRuleMetadataFilter>?>?

Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Structure is documented below.

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 portRange 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

pscConnectionId → Input<String?>?

The PSC connection id of the PSC Forwarding Rule.

final

pscConnectionStatus → Input<String?>?

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

final

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

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selfLink → Input<String?>?

The URI of the created resource.

final

serviceDirectoryRegistrations → Input<GlobalForwardingRuleServiceDirectoryRegistrations?>?

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

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