Struct GlobalForwardingRuleResult

pub struct GlobalForwardingRuleResult {

    pub allow_psc_global_access: Output<Option<bool>>,
    pub base_forwarding_rule: Output<String>,
    pub description: Output<Option<String>>,
    pub effective_labels: Output<HashMap<String, String>>,
    pub forwarding_rule_id: Output<i32>,
    pub ip_address: Output<String>,
    pub ip_protocol: Output<String>,
    pub ip_version: Output<Option<String>>,
    pub label_fingerprint: Output<String>,
    pub labels: Output<Option<HashMap<String, String>>>,
    pub load_balancing_scheme: Output<Option<String>>,
    pub metadata_filters: Output<Option<Vec<GlobalForwardingRuleMetadataFilter>>>,
    pub name: Output<String>,
    pub network: Output<String>,
    pub network_tier: Output<String>,
    pub no_automate_dns_zone: Output<Option<bool>>,
    pub port_range: Output<Option<String>>,
    pub project: Output<String>,
    pub psc_connection_id: Output<String>,
    pub psc_connection_status: Output<String>,
    pub pulumi_labels: Output<HashMap<String, String>>,
    pub self_link: Output<String>,
    pub service_directory_registrations: Output<GlobalForwardingRuleServiceDirectoryRegistrations>,
    pub source_ip_ranges: Output<Option<Vec<String>>>,
    pub subnetwork: Output<String>,
    pub target: Output<String>,
}

Fields

allow_psc_global_access: Output<Option<bool>>

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

base_forwarding_rule: Output<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.

description: Output<Option<String>>

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

effective_labels: Output<HashMap<String, String>>

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

forwarding_rule_id: Output<i32>

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

ip_address: Output<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:

• 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, 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.

ip_protocol: Output<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.

ip_version: Output<Option<String>>

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

label_fingerprint: Output<String>

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

labels: Output<Option<HashMap<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.

load_balancing_scheme: Output<Option<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.

metadata_filters: Output<Option<Vec<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.

name: Output<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: Output<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.

network_tier: Output<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.

no_automate_dns_zone: Output<Option<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: Output<Option<String>>

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 portRanges. 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 portRanges. @pattern: \d+(?:-\d+)?

project: Output<String>

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

psc_connection_id: Output<String>

The PSC connection id of the PSC Forwarding Rule.

psc_connection_status: Output<String>

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

pulumi_labels: Output<HashMap<String, String>>

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

self_link: Output<String>

The URI of the created resource.

service_directory_registrations: Output<GlobalForwardingRuleServiceDirectoryRegistrations>

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

source_ip_ranges: Output<Option<Vec<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: Output<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: Output<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.

---