Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/beta
  6. ForwardingRule

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.compute/beta.ForwardingRule

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a ForwardingRule resource in the specified project and region using the data included in the request.

    Create ForwardingRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ForwardingRule(name: string, args: ForwardingRuleArgs, opts?: CustomResourceOptions);
    @overload
def ForwardingRule(resource_name: str,
                   args: ForwardingRuleArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ForwardingRule(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   region: Optional[str] = None,
                   ip_protocol: Optional[ForwardingRuleIpProtocol] = None,
                   target: Optional[str] = None,
                   name: Optional[str] = None,
                   backend_service: Optional[str] = None,
                   description: Optional[str] = None,
                   ip_address: Optional[str] = None,
                   all_ports: Optional[bool] = None,
                   ip_version: Optional[ForwardingRuleIpVersion] = None,
                   is_mirroring_collector: Optional[bool] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   load_balancing_scheme: Optional[ForwardingRuleLoadBalancingScheme] = None,
                   metadata_filters: Optional[Sequence[MetadataFilterArgs]] = None,
                   allow_psc_packet_injection: Optional[bool] = None,
                   allow_psc_global_access: Optional[bool] = None,
                   request_id: Optional[str] = None,
                   no_automate_dns_zone: Optional[bool] = None,
                   port_range: Optional[str] = None,
                   ports: Optional[Sequence[str]] = None,
                   project: Optional[str] = None,
                   psc_connection_status: Optional[ForwardingRulePscConnectionStatus] = None,
                   allow_global_access: Optional[bool] = None,
                   network_tier: Optional[ForwardingRuleNetworkTier] = None,
                   service_directory_registrations: Optional[Sequence[ForwardingRuleServiceDirectoryRegistrationArgs]] = None,
                   service_label: Optional[str] = None,
                   source_ip_ranges: Optional[Sequence[str]] = None,
                   subnetwork: Optional[str] = None,
                   network: Optional[str] = None)
    func NewForwardingRule(ctx *Context, name string, args ForwardingRuleArgs, opts ...ResourceOption) (*ForwardingRule, error)
    public ForwardingRule(string name, ForwardingRuleArgs args, CustomResourceOptions? opts = null)
    public ForwardingRule(String name, ForwardingRuleArgs args)
public ForwardingRule(String name, ForwardingRuleArgs args, CustomResourceOptions options)

    type: google-native:compute/beta:ForwardingRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ForwardingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ForwardingRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ForwardingRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ForwardingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ForwardingRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var google_nativeForwardingRuleResource = new GoogleNative.Compute.Beta.ForwardingRule("google-nativeForwardingRuleResource", new()
{
    Region = "string",
    IpProtocol = GoogleNative.Compute.Beta.ForwardingRuleIpProtocol.Ah,
    Target = "string",
    Name = "string",
    BackendService = "string",
    Description = "string",
    IpAddress = "string",
    AllPorts = false,
    IpVersion = GoogleNative.Compute.Beta.ForwardingRuleIpVersion.Ipv4,
    IsMirroringCollector = false,
    Labels = 
    {
        { "string", "string" },
    },
    LoadBalancingScheme = GoogleNative.Compute.Beta.ForwardingRuleLoadBalancingScheme.External,
    MetadataFilters = new[]
    {
        new GoogleNative.Compute.Beta.Inputs.MetadataFilterArgs
        {
            FilterLabels = new[]
            {
                new GoogleNative.Compute.Beta.Inputs.MetadataFilterLabelMatchArgs
                {
                    Name = "string",
                    Value = "string",
                },
            },
            FilterMatchCriteria = GoogleNative.Compute.Beta.MetadataFilterFilterMatchCriteria.MatchAll,
        },
    },
    AllowPscPacketInjection = false,
    AllowPscGlobalAccess = false,
    RequestId = "string",
    NoAutomateDnsZone = false,
    PortRange = "string",
    Ports = new[]
    {
        "string",
    },
    Project = "string",
    PscConnectionStatus = GoogleNative.Compute.Beta.ForwardingRulePscConnectionStatus.Accepted,
    AllowGlobalAccess = false,
    NetworkTier = GoogleNative.Compute.Beta.ForwardingRuleNetworkTier.FixedStandard,
    ServiceDirectoryRegistrations = new[]
    {
        new GoogleNative.Compute.Beta.Inputs.ForwardingRuleServiceDirectoryRegistrationArgs
        {
            Namespace = "string",
            Service = "string",
            ServiceDirectoryRegion = "string",
        },
    },
    ServiceLabel = "string",
    SourceIpRanges = new[]
    {
        "string",
    },
    Subnetwork = "string",
    Network = "string",
});

    example, err := computebeta.NewForwardingRule(ctx, "google-nativeForwardingRuleResource", &computebeta.ForwardingRuleArgs{
Region: pulumi.String("string"),
IpProtocol: computebeta.ForwardingRuleIpProtocolAh,
Target: pulumi.String("string"),
Name: pulumi.String("string"),
BackendService: pulumi.String("string"),
Description: pulumi.String("string"),
IpAddress: pulumi.String("string"),
AllPorts: pulumi.Bool(false),
IpVersion: computebeta.ForwardingRuleIpVersionIpv4,
IsMirroringCollector: pulumi.Bool(false),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
LoadBalancingScheme: computebeta.ForwardingRuleLoadBalancingSchemeExternal,
MetadataFilters: compute.MetadataFilterArray{
&compute.MetadataFilterArgs{
FilterLabels: compute.MetadataFilterLabelMatchArray{
&compute.MetadataFilterLabelMatchArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
FilterMatchCriteria: computebeta.MetadataFilterFilterMatchCriteriaMatchAll,
},
},
AllowPscPacketInjection: pulumi.Bool(false),
AllowPscGlobalAccess: pulumi.Bool(false),
RequestId: pulumi.String("string"),
NoAutomateDnsZone: pulumi.Bool(false),
PortRange: pulumi.String("string"),
Ports: pulumi.StringArray{
pulumi.String("string"),
},
Project: pulumi.String("string"),
PscConnectionStatus: computebeta.ForwardingRulePscConnectionStatusAccepted,
AllowGlobalAccess: pulumi.Bool(false),
NetworkTier: computebeta.ForwardingRuleNetworkTierFixedStandard,
ServiceDirectoryRegistrations: compute.ForwardingRuleServiceDirectoryRegistrationArray{
&compute.ForwardingRuleServiceDirectoryRegistrationArgs{
Namespace: pulumi.String("string"),
Service: pulumi.String("string"),
ServiceDirectoryRegion: pulumi.String("string"),
},
},
ServiceLabel: pulumi.String("string"),
SourceIpRanges: pulumi.StringArray{
pulumi.String("string"),
},
Subnetwork: pulumi.String("string"),
Network: pulumi.String("string"),
})

    var google_nativeForwardingRuleResource = new ForwardingRule("google-nativeForwardingRuleResource", ForwardingRuleArgs.builder()
    .region("string")
    .ipProtocol("AH")
    .target("string")
    .name("string")
    .backendService("string")
    .description("string")
    .ipAddress("string")
    .allPorts(false)
    .ipVersion("IPV4")
    .isMirroringCollector(false)
    .labels(Map.of("string", "string"))
    .loadBalancingScheme("EXTERNAL")
    .metadataFilters(MetadataFilterArgs.builder()
        .filterLabels(MetadataFilterLabelMatchArgs.builder()
            .name("string")
            .value("string")
            .build())
        .filterMatchCriteria("MATCH_ALL")
        .build())
    .allowPscPacketInjection(false)
    .allowPscGlobalAccess(false)
    .requestId("string")
    .noAutomateDnsZone(false)
    .portRange("string")
    .ports("string")
    .project("string")
    .pscConnectionStatus("ACCEPTED")
    .allowGlobalAccess(false)
    .networkTier("FIXED_STANDARD")
    .serviceDirectoryRegistrations(ForwardingRuleServiceDirectoryRegistrationArgs.builder()
        .namespace("string")
        .service("string")
        .serviceDirectoryRegion("string")
        .build())
    .serviceLabel("string")
    .sourceIpRanges("string")
    .subnetwork("string")
    .network("string")
    .build());

    google_native_forwarding_rule_resource = google_native.compute.beta.ForwardingRule("google-nativeForwardingRuleResource",
    region="string",
    ip_protocol=google_native.compute.beta.ForwardingRuleIpProtocol.AH,
    target="string",
    name="string",
    backend_service="string",
    description="string",
    ip_address="string",
    all_ports=False,
    ip_version=google_native.compute.beta.ForwardingRuleIpVersion.IPV4,
    is_mirroring_collector=False,
    labels={
        "string": "string",
    },
    load_balancing_scheme=google_native.compute.beta.ForwardingRuleLoadBalancingScheme.EXTERNAL,
    metadata_filters=[google_native.compute.beta.MetadataFilterArgs(
        filter_labels=[google_native.compute.beta.MetadataFilterLabelMatchArgs(
            name="string",
            value="string",
        )],
        filter_match_criteria=google_native.compute.beta.MetadataFilterFilterMatchCriteria.MATCH_ALL,
    )],
    allow_psc_packet_injection=False,
    allow_psc_global_access=False,
    request_id="string",
    no_automate_dns_zone=False,
    port_range="string",
    ports=["string"],
    project="string",
    psc_connection_status=google_native.compute.beta.ForwardingRulePscConnectionStatus.ACCEPTED,
    allow_global_access=False,
    network_tier=google_native.compute.beta.ForwardingRuleNetworkTier.FIXED_STANDARD,
    service_directory_registrations=[google_native.compute.beta.ForwardingRuleServiceDirectoryRegistrationArgs(
        namespace="string",
        service="string",
        service_directory_region="string",
    )],
    service_label="string",
    source_ip_ranges=["string"],
    subnetwork="string",
    network="string")

    const google_nativeForwardingRuleResource = new google_native.compute.beta.ForwardingRule("google-nativeForwardingRuleResource", {
    region: "string",
    ipProtocol: google_native.compute.beta.ForwardingRuleIpProtocol.Ah,
    target: "string",
    name: "string",
    backendService: "string",
    description: "string",
    ipAddress: "string",
    allPorts: false,
    ipVersion: google_native.compute.beta.ForwardingRuleIpVersion.Ipv4,
    isMirroringCollector: false,
    labels: {
        string: "string",
    },
    loadBalancingScheme: google_native.compute.beta.ForwardingRuleLoadBalancingScheme.External,
    metadataFilters: [{
        filterLabels: [{
            name: "string",
            value: "string",
        }],
        filterMatchCriteria: google_native.compute.beta.MetadataFilterFilterMatchCriteria.MatchAll,
    }],
    allowPscPacketInjection: false,
    allowPscGlobalAccess: false,
    requestId: "string",
    noAutomateDnsZone: false,
    portRange: "string",
    ports: ["string"],
    project: "string",
    pscConnectionStatus: google_native.compute.beta.ForwardingRulePscConnectionStatus.Accepted,
    allowGlobalAccess: false,
    networkTier: google_native.compute.beta.ForwardingRuleNetworkTier.FixedStandard,
    serviceDirectoryRegistrations: [{
        namespace: "string",
        service: "string",
        serviceDirectoryRegion: "string",
    }],
    serviceLabel: "string",
    sourceIpRanges: ["string"],
    subnetwork: "string",
    network: "string",
});

    type: google-native:compute/beta:ForwardingRule
properties:
    allPorts: false
    allowGlobalAccess: false
    allowPscGlobalAccess: false
    allowPscPacketInjection: false
    backendService: string
    description: string
    ipAddress: string
    ipProtocol: AH
    ipVersion: IPV4
    isMirroringCollector: false
    labels:
        string: string
    loadBalancingScheme: EXTERNAL
    metadataFilters:
        - filterLabels:
            - name: string
              value: string
          filterMatchCriteria: MATCH_ALL
    name: string
    network: string
    networkTier: FIXED_STANDARD
    noAutomateDnsZone: false
    portRange: string
    ports:
        - string
    project: string
    pscConnectionStatus: ACCEPTED
    region: string
    requestId: string
    serviceDirectoryRegistrations:
        - namespace: string
          service: string
          serviceDirectoryRegion: string
    serviceLabel: string
    sourceIpRanges:
        - string
    subnetwork: string
    target: string

    ForwardingRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ForwardingRule resource accepts the following input properties:

    Region string
    AllPorts 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: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true.
    AllowGlobalAccess bool
    This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
    AllowPscGlobalAccess bool
    This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
    AllowPscPacketInjection bool
    This is used in PSC consumer ForwardingRule to control whether the producer is allowed to inject packets into the consumer's network. If set to true, the target service attachment must have tunneling enabled and TunnelingConfig.RoutingMode set to PACKET_INJECTION Non-PSC forwarding rules should not use this field.
    BackendService 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.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    IpAddress 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: - 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 or backendService, 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.
    IpProtocol Pulumi.GoogleNative.Compute.Beta.ForwardingRuleIpProtocol
    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.
    IpVersion Pulumi.GoogleNative.Compute.Beta.ForwardingRuleIpVersion
    The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
    IsMirroringCollector 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.
    Labels Dictionary<string, string>
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    LoadBalancingScheme Pulumi.GoogleNative.Compute.Beta.ForwardingRuleLoadBalancingScheme
    Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
    MetadataFilters List<Pulumi.GoogleNative.Compute.Beta.Inputs.MetadataFilter>
    Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible 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 provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
    Name 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]([-a-z0-9]*[a-z0-9])? 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 string
    This field is not used for global 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.
    NetworkTier Pulumi.GoogleNative.Compute.Beta.ForwardingRuleNetworkTier
    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.
    NoAutomateDnsZone 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. Once set, this field is not mutable.
    PortRange 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: - 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+)?
    Ports 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: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \d+(?:-\d+)?
    Project string
    PscConnectionStatus Pulumi.GoogleNative.Compute.Beta.ForwardingRulePscConnectionStatus
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    ServiceDirectoryRegistrations List<Pulumi.GoogleNative.Compute.Beta.Inputs.ForwardingRuleServiceDirectoryRegistration>
    Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
    ServiceLabel string
    An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is 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]([-a-z0-9]*[a-z0-9])? 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.
    SourceIpRanges 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 source_ip_range 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 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 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. The target is not mutable once set as a service attachment.
    Region string
    AllPorts 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: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true.
    AllowGlobalAccess bool
    This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
    AllowPscGlobalAccess bool
    This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
    AllowPscPacketInjection bool
    This is used in PSC consumer ForwardingRule to control whether the producer is allowed to inject packets into the consumer's network. If set to true, the target service attachment must have tunneling enabled and TunnelingConfig.RoutingMode set to PACKET_INJECTION Non-PSC forwarding rules should not use this field.
    BackendService 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.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    IpAddress 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: - 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 or backendService, 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.
    IpProtocol ForwardingRuleIpProtocol
    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.
    IpVersion ForwardingRuleIpVersion
    The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
    IsMirroringCollector 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.
    Labels map[string]string
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    LoadBalancingScheme ForwardingRuleLoadBalancingScheme
    Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
    MetadataFilters []MetadataFilterArgs
    Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible 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 provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
    Name 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]([-a-z0-9]*[a-z0-9])? 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 string
    This field is not used for global 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.
    NetworkTier ForwardingRuleNetworkTier
    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.
    NoAutomateDnsZone 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. Once set, this field is not mutable.
    PortRange 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: - 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+)?
    Ports []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: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \d+(?:-\d+)?
    Project string
    PscConnectionStatus ForwardingRulePscConnectionStatus
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    ServiceDirectoryRegistrations []ForwardingRuleServiceDirectoryRegistrationArgs
    Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
    ServiceLabel string
    An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is 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]([-a-z0-9]*[a-z0-9])? 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.
    SourceIpRanges []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 source_ip_range 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 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 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. The target is not mutable once set as a service attachment.
    region String
    allPorts Boolean
    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: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true.
    allowGlobalAccess Boolean
    This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
    allowPscGlobalAccess Boolean
    This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
    allowPscPacketInjection Boolean
    This is used in PSC consumer ForwardingRule to control whether the producer is allowed to inject packets into the consumer's network. If set to true, the target service attachment must have tunneling enabled and TunnelingConfig.RoutingMode set to PACKET_INJECTION Non-PSC forwarding rules should not use this field.
    backendService 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.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    ipAddress 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: - 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 or backendService, 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.
    ipProtocol ForwardingRuleIpProtocol
    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.
    ipVersion ForwardingRuleIpVersion
    The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
    isMirroringCollector Boolean
    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.
    labels Map<String,String>
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    loadBalancingScheme ForwardingRuleLoadBalancingScheme
    Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
    metadataFilters List<MetadataFilter>
    Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible 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 provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
    name 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]([-a-z0-9]*[a-z0-9])? 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 String
    This field is not used for global 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.
    networkTier ForwardingRuleNetworkTier
    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.
    noAutomateDnsZone Boolean
    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. Once set, this field is not mutable.
    portRange 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: - 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+)?
    ports 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: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \d+(?:-\d+)?
    project String
    pscConnectionStatus ForwardingRulePscConnectionStatus
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    serviceDirectoryRegistrations List<ForwardingRuleServiceDirectoryRegistration>
    Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
    serviceLabel String
    An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is 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]([-a-z0-9]*[a-z0-9])? 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.
    sourceIpRanges 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 source_ip_range 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 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 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. The target is not mutable once set as a service attachment.
    region string
    allPorts boolean
    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: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true.
    allowGlobalAccess boolean
    This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
    allowPscGlobalAccess boolean
    This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
    allowPscPacketInjection boolean
    This is used in PSC consumer ForwardingRule to control whether the producer is allowed to inject packets into the consumer's network. If set to true, the target service attachment must have tunneling enabled and TunnelingConfig.RoutingMode set to PACKET_INJECTION Non-PSC forwarding rules should not use this field.
    backendService 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.
    description string
    An optional description of this resource. Provide this property when you create the resource.
    ipAddress 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: - 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 or backendService, 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.
    ipProtocol ForwardingRuleIpProtocol
    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.
    ipVersion ForwardingRuleIpVersion
    The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
    isMirroringCollector boolean
    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.
    labels {[key: string]: string}
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    loadBalancingScheme ForwardingRuleLoadBalancingScheme
    Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
    metadataFilters MetadataFilter[]
    Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible 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 provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
    name 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]([-a-z0-9]*[a-z0-9])? 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 string
    This field is not used for global 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.
    networkTier ForwardingRuleNetworkTier
    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.
    noAutomateDnsZone boolean
    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. Once set, this field is not mutable.
    portRange 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: - 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+)?
    ports 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: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \d+(?:-\d+)?
    project string
    pscConnectionStatus ForwardingRulePscConnectionStatus
    requestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    serviceDirectoryRegistrations ForwardingRuleServiceDirectoryRegistration[]
    Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
    serviceLabel string
    An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is 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]([-a-z0-9]*[a-z0-9])? 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.
    sourceIpRanges 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 source_ip_range 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 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 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. The target is not mutable once set as a service attachment.
    region str
    all_ports 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: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true.
    allow_global_access bool
    This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
    allow_psc_global_access bool
    This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
    allow_psc_packet_injection bool
    This is used in PSC consumer ForwardingRule to control whether the producer is allowed to inject packets into the consumer's network. If set to true, the target service attachment must have tunneling enabled and TunnelingConfig.RoutingMode set to PACKET_INJECTION Non-PSC forwarding rules should not use this field.
    backend_service str
    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.
    description str
    An optional description of this resource. Provide this property when you create the resource.
    ip_address str
    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: - 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 or backendService, 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 ForwardingRuleIpProtocol
    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.
    ip_version ForwardingRuleIpVersion
    The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
    is_mirroring_collector 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.
    labels Mapping[str, str]
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    load_balancing_scheme ForwardingRuleLoadBalancingScheme
    Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
    metadata_filters Sequence[MetadataFilterArgs]
    Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible 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 provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
    name str
    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]([-a-z0-9]*[a-z0-9])? 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 str
    This field is not used for global 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 ForwardingRuleNetworkTier
    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.
    no_automate_dns_zone 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. Once set, this field is not mutable.
    port_range str
    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: - 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+)?
    ports Sequence[str]
    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: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \d+(?:-\d+)?
    project str
    psc_connection_status ForwardingRulePscConnectionStatus
    request_id str
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    service_directory_registrations Sequence[ForwardingRuleServiceDirectoryRegistrationArgs]
    Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
    service_label str
    An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is 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]([-a-z0-9]*[a-z0-9])? 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.
    source_ip_ranges Sequence[str]
    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 source_ip_range 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 str
    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 str
    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. The target is not mutable once set as a service attachment.
    region String
    allPorts Boolean
    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: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true.
    allowGlobalAccess Boolean
    This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.
    allowPscGlobalAccess Boolean
    This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
    allowPscPacketInjection Boolean
    This is used in PSC consumer ForwardingRule to control whether the producer is allowed to inject packets into the consumer's network. If set to true, the target service attachment must have tunneling enabled and TunnelingConfig.RoutingMode set to PACKET_INJECTION Non-PSC forwarding rules should not use this field.
    backendService 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.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    ipAddress 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: - 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 or backendService, 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.
    ipProtocol "AH" | "ESP" | "ICMP" | "L3_DEFAULT" | "SCTP" | "TCP" | "UDP"
    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.
    ipVersion "IPV4" | "IPV6" | "UNSPECIFIED_VERSION"
    The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
    isMirroringCollector Boolean
    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.
    labels Map<String>
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    loadBalancingScheme "EXTERNAL" | "EXTERNAL_MANAGED" | "INTERNAL" | "INTERNAL_MANAGED" | "INTERNAL_SELF_MANAGED" | "INVALID"
    Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
    metadataFilters List<Property Map>
    Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible 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 provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
    name 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]([-a-z0-9]*[a-z0-9])? 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 String
    This field is not used for global 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.
    networkTier "FIXED_STANDARD" | "PREMIUM" | "STANDARD" | "STANDARD_OVERRIDES_FIXED_STANDARD"
    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.
    noAutomateDnsZone Boolean
    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. Once set, this field is not mutable.
    portRange 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: - 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+)?
    ports 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: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \d+(?:-\d+)?
    project String
    pscConnectionStatus "ACCEPTED" | "CLOSED" | "NEEDS_ATTENTION" | "PENDING" | "REJECTED" | "STATUS_UNSPECIFIED"
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    serviceDirectoryRegistrations List<Property Map>
    Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
    serviceLabel String
    An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is 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]([-a-z0-9]*[a-z0-9])? 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.
    sourceIpRanges 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 source_ip_range 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 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 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. The target is not mutable once set as a service attachment.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ForwardingRule resource produces the following output properties:

    BaseForwardingRule string
    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.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Fingerprint string
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    LabelFingerprint string
    A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    PscConnectionId string
    The PSC connection id of the PSC Forwarding Rule.
    SelfLink string
    Server-defined URL for the resource.
    ServiceName string
    The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
    BaseForwardingRule string
    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.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Fingerprint string
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    LabelFingerprint string
    A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    PscConnectionId string
    The PSC connection id of the PSC Forwarding Rule.
    SelfLink string
    Server-defined URL for the resource.
    ServiceName string
    The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
    baseForwardingRule String
    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.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    fingerprint String
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    labelFingerprint String
    A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    pscConnectionId String
    The PSC connection id of the PSC Forwarding Rule.
    selfLink String
    Server-defined URL for the resource.
    serviceName String
    The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
    baseForwardingRule string
    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.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    fingerprint string
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    labelFingerprint string
    A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    pscConnectionId string
    The PSC connection id of the PSC Forwarding Rule.
    selfLink string
    Server-defined URL for the resource.
    serviceName string
    The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
    base_forwarding_rule str
    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.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    fingerprint str
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    label_fingerprint str
    A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    psc_connection_id str
    The PSC connection id of the PSC Forwarding Rule.
    self_link str
    Server-defined URL for the resource.
    service_name str
    The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
    baseForwardingRule String
    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.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    fingerprint String
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
    labelFingerprint String
    A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
    pscConnectionId String
    The PSC connection id of the PSC Forwarding Rule.
    selfLink String
    Server-defined URL for the resource.
    serviceName String
    The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.

    Supporting Types

    ForwardingRuleIpProtocol, ForwardingRuleIpProtocolArgs

    Ah
    AH
    Esp
    ESP
    Icmp
    ICMP
    L3Default
    L3_DEFAULT
    Sctp
    SCTP
    Tcp
    TCP
    Udp
    UDP
    ForwardingRuleIpProtocolAh
    AH
    ForwardingRuleIpProtocolEsp
    ESP
    ForwardingRuleIpProtocolIcmp
    ICMP
    ForwardingRuleIpProtocolL3Default
    L3_DEFAULT
    ForwardingRuleIpProtocolSctp
    SCTP
    ForwardingRuleIpProtocolTcp
    TCP
    ForwardingRuleIpProtocolUdp
    UDP
    Ah
    AH
    Esp
    ESP
    Icmp
    ICMP
    L3Default
    L3_DEFAULT
    Sctp
    SCTP
    Tcp
    TCP
    Udp
    UDP
    Ah
    AH
    Esp
    ESP
    Icmp
    ICMP
    L3Default
    L3_DEFAULT
    Sctp
    SCTP
    Tcp
    TCP
    Udp
    UDP
    AH
    AH
    ESP
    ESP
    ICMP
    ICMP
    L3_DEFAULT
    L3_DEFAULT
    SCTP
    SCTP
    TCP
    TCP
    UDP
    UDP
    "AH"
    AH
    "ESP"
    ESP
    "ICMP"
    ICMP
    "L3_DEFAULT"
    L3_DEFAULT
    "SCTP"
    SCTP
    "TCP"
    TCP
    "UDP"
    UDP

    ForwardingRuleIpVersion, ForwardingRuleIpVersionArgs

    Ipv4
    IPV4
    Ipv6
    IPV6
    UnspecifiedVersion
    UNSPECIFIED_VERSION
    ForwardingRuleIpVersionIpv4
    IPV4
    ForwardingRuleIpVersionIpv6
    IPV6
    ForwardingRuleIpVersionUnspecifiedVersion
    UNSPECIFIED_VERSION
    Ipv4
    IPV4
    Ipv6
    IPV6
    UnspecifiedVersion
    UNSPECIFIED_VERSION
    Ipv4
    IPV4
    Ipv6
    IPV6
    UnspecifiedVersion
    UNSPECIFIED_VERSION
    IPV4
    IPV4
    IPV6
    IPV6
    UNSPECIFIED_VERSION
    UNSPECIFIED_VERSION
    "IPV4"
    IPV4
    "IPV6"
    IPV6
    "UNSPECIFIED_VERSION"
    UNSPECIFIED_VERSION

    ForwardingRuleLoadBalancingScheme, ForwardingRuleLoadBalancingSchemeArgs

    External
    EXTERNAL
    ExternalManaged
    EXTERNAL_MANAGED
    Internal
    INTERNAL
    InternalManaged
    INTERNAL_MANAGED
    InternalSelfManaged
    INTERNAL_SELF_MANAGED
    Invalid
    INVALID
    ForwardingRuleLoadBalancingSchemeExternal
    EXTERNAL
    ForwardingRuleLoadBalancingSchemeExternalManaged
    EXTERNAL_MANAGED
    ForwardingRuleLoadBalancingSchemeInternal
    INTERNAL
    ForwardingRuleLoadBalancingSchemeInternalManaged
    INTERNAL_MANAGED
    ForwardingRuleLoadBalancingSchemeInternalSelfManaged
    INTERNAL_SELF_MANAGED
    ForwardingRuleLoadBalancingSchemeInvalid
    INVALID
    External
    EXTERNAL
    ExternalManaged
    EXTERNAL_MANAGED
    Internal
    INTERNAL
    InternalManaged
    INTERNAL_MANAGED
    InternalSelfManaged
    INTERNAL_SELF_MANAGED
    Invalid
    INVALID
    External
    EXTERNAL
    ExternalManaged
    EXTERNAL_MANAGED
    Internal
    INTERNAL
    InternalManaged
    INTERNAL_MANAGED
    InternalSelfManaged
    INTERNAL_SELF_MANAGED
    Invalid
    INVALID
    EXTERNAL
    EXTERNAL
    EXTERNAL_MANAGED
    EXTERNAL_MANAGED
    INTERNAL
    INTERNAL
    INTERNAL_MANAGED
    INTERNAL_MANAGED
    INTERNAL_SELF_MANAGED
    INTERNAL_SELF_MANAGED
    INVALID
    INVALID
    "EXTERNAL"
    EXTERNAL
    "EXTERNAL_MANAGED"
    EXTERNAL_MANAGED
    "INTERNAL"
    INTERNAL
    "INTERNAL_MANAGED"
    INTERNAL_MANAGED
    "INTERNAL_SELF_MANAGED"
    INTERNAL_SELF_MANAGED
    "INVALID"
    INVALID

    ForwardingRuleNetworkTier, ForwardingRuleNetworkTierArgs

    FixedStandard
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    Premium
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    Standard
    STANDARDPublic internet quality, only limited support for other networking products.
    StandardOverridesFixedStandard
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    ForwardingRuleNetworkTierFixedStandard
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    ForwardingRuleNetworkTierPremium
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    ForwardingRuleNetworkTierStandard
    STANDARDPublic internet quality, only limited support for other networking products.
    ForwardingRuleNetworkTierStandardOverridesFixedStandard
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    FixedStandard
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    Premium
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    Standard
    STANDARDPublic internet quality, only limited support for other networking products.
    StandardOverridesFixedStandard
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    FixedStandard
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    Premium
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    Standard
    STANDARDPublic internet quality, only limited support for other networking products.
    StandardOverridesFixedStandard
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    FIXED_STANDARD
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    PREMIUM
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    STANDARD
    STANDARDPublic internet quality, only limited support for other networking products.
    STANDARD_OVERRIDES_FIXED_STANDARD
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
    "FIXED_STANDARD"
    FIXED_STANDARDPublic internet quality with fixed bandwidth.
    "PREMIUM"
    PREMIUMHigh quality, Google-grade network tier, support for all networking products.
    "STANDARD"
    STANDARDPublic internet quality, only limited support for other networking products.
    "STANDARD_OVERRIDES_FIXED_STANDARD"
    STANDARD_OVERRIDES_FIXED_STANDARD(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.

    ForwardingRulePscConnectionStatus, ForwardingRulePscConnectionStatusArgs

    Accepted
    ACCEPTEDThe connection has been accepted by the producer.
    Closed
    CLOSEDThe connection has been closed by the producer and will not serve traffic going forward.
    NeedsAttention
    NEEDS_ATTENTIONThe connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.
    Pending
    PENDINGThe connection is pending acceptance by the producer.
    Rejected
    REJECTEDThe connection has been rejected by the producer.
    StatusUnspecified
    STATUS_UNSPECIFIED
    ForwardingRulePscConnectionStatusAccepted
    ACCEPTEDThe connection has been accepted by the producer.
    ForwardingRulePscConnectionStatusClosed
    CLOSEDThe connection has been closed by the producer and will not serve traffic going forward.
    ForwardingRulePscConnectionStatusNeedsAttention
    NEEDS_ATTENTIONThe connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.
    ForwardingRulePscConnectionStatusPending
    PENDINGThe connection is pending acceptance by the producer.
    ForwardingRulePscConnectionStatusRejected
    REJECTEDThe connection has been rejected by the producer.
    ForwardingRulePscConnectionStatusStatusUnspecified
    STATUS_UNSPECIFIED
    Accepted
    ACCEPTEDThe connection has been accepted by the producer.
    Closed
    CLOSEDThe connection has been closed by the producer and will not serve traffic going forward.
    NeedsAttention
    NEEDS_ATTENTIONThe connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.
    Pending
    PENDINGThe connection is pending acceptance by the producer.
    Rejected
    REJECTEDThe connection has been rejected by the producer.
    StatusUnspecified
    STATUS_UNSPECIFIED
    Accepted
    ACCEPTEDThe connection has been accepted by the producer.
    Closed
    CLOSEDThe connection has been closed by the producer and will not serve traffic going forward.
    NeedsAttention
    NEEDS_ATTENTIONThe connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.
    Pending
    PENDINGThe connection is pending acceptance by the producer.
    Rejected
    REJECTEDThe connection has been rejected by the producer.
    StatusUnspecified
    STATUS_UNSPECIFIED
    ACCEPTED
    ACCEPTEDThe connection has been accepted by the producer.
    CLOSED
    CLOSEDThe connection has been closed by the producer and will not serve traffic going forward.
    NEEDS_ATTENTION
    NEEDS_ATTENTIONThe connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.
    PENDING
    PENDINGThe connection is pending acceptance by the producer.
    REJECTED
    REJECTEDThe connection has been rejected by the producer.
    STATUS_UNSPECIFIED
    STATUS_UNSPECIFIED
    "ACCEPTED"
    ACCEPTEDThe connection has been accepted by the producer.
    "CLOSED"
    CLOSEDThe connection has been closed by the producer and will not serve traffic going forward.
    "NEEDS_ATTENTION"
    NEEDS_ATTENTIONThe connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.
    "PENDING"
    PENDINGThe connection is pending acceptance by the producer.
    "REJECTED"
    REJECTEDThe connection has been rejected by the producer.
    "STATUS_UNSPECIFIED"
    STATUS_UNSPECIFIED

    ForwardingRuleServiceDirectoryRegistration, ForwardingRuleServiceDirectoryRegistrationArgs

    Namespace string
    Service Directory namespace to register the forwarding rule under.
    Service string
    Service Directory service to register the forwarding rule under.
    ServiceDirectoryRegion string
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    Namespace string
    Service Directory namespace to register the forwarding rule under.
    Service string
    Service Directory service to register the forwarding rule under.
    ServiceDirectoryRegion string
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    namespace String
    Service Directory namespace to register the forwarding rule under.
    service String
    Service Directory service to register the forwarding rule under.
    serviceDirectoryRegion String
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    namespace string
    Service Directory namespace to register the forwarding rule under.
    service string
    Service Directory service to register the forwarding rule under.
    serviceDirectoryRegion string
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    namespace str
    Service Directory namespace to register the forwarding rule under.
    service str
    Service Directory service to register the forwarding rule under.
    service_directory_region str
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    namespace String
    Service Directory namespace to register the forwarding rule under.
    service String
    Service Directory service to register the forwarding rule under.
    serviceDirectoryRegion String
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.

    ForwardingRuleServiceDirectoryRegistrationResponse, ForwardingRuleServiceDirectoryRegistrationResponseArgs

    Namespace string
    Service Directory namespace to register the forwarding rule under.
    Service string
    Service Directory service to register the forwarding rule under.
    ServiceDirectoryRegion string
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    Namespace string
    Service Directory namespace to register the forwarding rule under.
    Service string
    Service Directory service to register the forwarding rule under.
    ServiceDirectoryRegion string
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    namespace String
    Service Directory namespace to register the forwarding rule under.
    service String
    Service Directory service to register the forwarding rule under.
    serviceDirectoryRegion String
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    namespace string
    Service Directory namespace to register the forwarding rule under.
    service string
    Service Directory service to register the forwarding rule under.
    serviceDirectoryRegion string
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    namespace str
    Service Directory namespace to register the forwarding rule under.
    service str
    Service Directory service to register the forwarding rule under.
    service_directory_region str
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.
    namespace String
    Service Directory namespace to register the forwarding rule under.
    service String
    Service Directory service to register the forwarding rule under.
    serviceDirectoryRegion String
    [Optional] Service Directory region to register this global forwarding rule under. Default to "us-central1". Only used for PSC for Google APIs. All PSC for Google APIs Forwarding Rules on the same network should use the same Service Directory region.

    MetadataFilter, MetadataFilterArgs

    FilterLabels List<Pulumi.GoogleNative.Compute.Beta.Inputs.MetadataFilterLabelMatch>
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    FilterMatchCriteria Pulumi.GoogleNative.Compute.Beta.MetadataFilterFilterMatchCriteria
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    FilterLabels []MetadataFilterLabelMatch
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    FilterMatchCriteria MetadataFilterFilterMatchCriteria
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    filterLabels List<MetadataFilterLabelMatch>
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    filterMatchCriteria MetadataFilterFilterMatchCriteria
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    filterLabels MetadataFilterLabelMatch[]
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    filterMatchCriteria MetadataFilterFilterMatchCriteria
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    filter_labels Sequence[MetadataFilterLabelMatch]
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    filter_match_criteria MetadataFilterFilterMatchCriteria
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    filterLabels List<Property Map>
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    filterMatchCriteria "MATCH_ALL" | "MATCH_ANY" | "NOT_SET"
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.

    MetadataFilterFilterMatchCriteria, MetadataFilterFilterMatchCriteriaArgs

    MatchAll
    MATCH_ALLSpecifies that all filterLabels must match for the metadataFilter to be considered a match.
    MatchAny
    MATCH_ANYSpecifies that any filterLabel must match for the metadataFilter to be considered a match.
    NotSet
    NOT_SETIndicates that the match criteria was not set. A metadataFilter must never be created with this value.
    MetadataFilterFilterMatchCriteriaMatchAll
    MATCH_ALLSpecifies that all filterLabels must match for the metadataFilter to be considered a match.
    MetadataFilterFilterMatchCriteriaMatchAny
    MATCH_ANYSpecifies that any filterLabel must match for the metadataFilter to be considered a match.
    MetadataFilterFilterMatchCriteriaNotSet
    NOT_SETIndicates that the match criteria was not set. A metadataFilter must never be created with this value.
    MatchAll
    MATCH_ALLSpecifies that all filterLabels must match for the metadataFilter to be considered a match.
    MatchAny
    MATCH_ANYSpecifies that any filterLabel must match for the metadataFilter to be considered a match.
    NotSet
    NOT_SETIndicates that the match criteria was not set. A metadataFilter must never be created with this value.
    MatchAll
    MATCH_ALLSpecifies that all filterLabels must match for the metadataFilter to be considered a match.
    MatchAny
    MATCH_ANYSpecifies that any filterLabel must match for the metadataFilter to be considered a match.
    NotSet
    NOT_SETIndicates that the match criteria was not set. A metadataFilter must never be created with this value.
    MATCH_ALL
    MATCH_ALLSpecifies that all filterLabels must match for the metadataFilter to be considered a match.
    MATCH_ANY
    MATCH_ANYSpecifies that any filterLabel must match for the metadataFilter to be considered a match.
    NOT_SET
    NOT_SETIndicates that the match criteria was not set. A metadataFilter must never be created with this value.
    "MATCH_ALL"
    MATCH_ALLSpecifies that all filterLabels must match for the metadataFilter to be considered a match.
    "MATCH_ANY"
    MATCH_ANYSpecifies that any filterLabel must match for the metadataFilter to be considered a match.
    "NOT_SET"
    NOT_SETIndicates that the match criteria was not set. A metadataFilter must never be created with this value.

    MetadataFilterLabelMatch, MetadataFilterLabelMatchArgs

    Name string
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    Value string
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    Name string
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    Value string
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    name String
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    value String
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    name string
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    value string
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    name str
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    value str
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    name String
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    value String
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.

    MetadataFilterLabelMatchResponse, MetadataFilterLabelMatchResponseArgs

    Name string
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    Value string
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    Name string
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    Value string
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    name String
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    value String
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    name string
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    value string
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    name str
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    value str
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.
    name String
    Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.
    value String
    The value of the label must match the specified value. value can have a maximum length of 1024 characters.

    MetadataFilterResponse, MetadataFilterResponseArgs

    FilterLabels List<Pulumi.GoogleNative.Compute.Beta.Inputs.MetadataFilterLabelMatchResponse>
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    FilterMatchCriteria string
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    FilterLabels []MetadataFilterLabelMatchResponse
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    FilterMatchCriteria string
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    filterLabels List<MetadataFilterLabelMatchResponse>
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    filterMatchCriteria String
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    filterLabels MetadataFilterLabelMatchResponse[]
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    filterMatchCriteria string
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    filter_labels Sequence[MetadataFilterLabelMatchResponse]
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    filter_match_criteria str
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.
    filterLabels List<Property Map>
    The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.
    filterMatchCriteria String
    Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native