1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. getGlobalForwardingRule
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

gcp.compute.getGlobalForwardingRule

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

    Get a global forwarding rule within GCE from its name.

    Example Usage

    data "google_compute_global_forwarding_rule" "my-forwarding-rule" {
      name = "forwarding-rule-global"
    }
    

    Using getGlobalForwardingRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGlobalForwardingRule(args: GetGlobalForwardingRuleArgs, opts?: InvokeOptions): Promise<GetGlobalForwardingRuleResult>
    function getGlobalForwardingRuleOutput(args: GetGlobalForwardingRuleOutputArgs, opts?: InvokeOptions): Output<GetGlobalForwardingRuleResult>
    def get_global_forwarding_rule(name: Optional[str] = None,
                                   project: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetGlobalForwardingRuleResult
    def get_global_forwarding_rule_output(name: Optional[pulumi.Input[str]] = None,
                                   project: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetGlobalForwardingRuleResult]
    func LookupGlobalForwardingRule(ctx *Context, args *LookupGlobalForwardingRuleArgs, opts ...InvokeOption) (*LookupGlobalForwardingRuleResult, error)
    func LookupGlobalForwardingRuleOutput(ctx *Context, args *LookupGlobalForwardingRuleOutputArgs, opts ...InvokeOption) LookupGlobalForwardingRuleResultOutput

    > Note: This function is named LookupGlobalForwardingRule in the Go SDK.

    public static class GetGlobalForwardingRule 
    {
        public static Task<GetGlobalForwardingRuleResult> InvokeAsync(GetGlobalForwardingRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetGlobalForwardingRuleResult> Invoke(GetGlobalForwardingRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGlobalForwardingRuleResult> getGlobalForwardingRule(GetGlobalForwardingRuleArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gcp:compute/getGlobalForwardingRule:getGlobalForwardingRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the global forwarding rule.


    Project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    Name string
    The name of the global forwarding rule.


    Project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    name String
    The name of the global forwarding rule.


    project String
    The project in which the resource belongs. If it is not provided, the provider project is used.
    name string
    The name of the global forwarding rule.


    project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    name str
    The name of the global forwarding rule.


    project str
    The project in which the resource belongs. If it is not provided, the provider project is used.
    name String
    The name of the global forwarding rule.


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

    getGlobalForwardingRule Result

    The following output properties are available:

    AllowPscGlobalAccess bool
    BaseForwardingRule string
    Description string
    EffectiveLabels Dictionary<string, string>
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    IpProtocol string
    IpVersion string
    LabelFingerprint string
    Labels Dictionary<string, string>
    LoadBalancingScheme string
    MetadataFilters List<GetGlobalForwardingRuleMetadataFilter>
    Name string
    Network string
    NoAutomateDnsZone bool
    PortRange string
    PscConnectionId string
    PscConnectionStatus string
    PulumiLabels Dictionary<string, string>
    SelfLink string
    ServiceDirectoryRegistrations List<GetGlobalForwardingRuleServiceDirectoryRegistration>
    SourceIpRanges List<string>
    Subnetwork string
    Target string
    Project string
    allowPscGlobalAccess boolean
    baseForwardingRule string
    description string
    effectiveLabels {[key: string]: string}
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    ipProtocol string
    ipVersion string
    labelFingerprint string
    labels {[key: string]: string}
    loadBalancingScheme string
    metadataFilters GetGlobalForwardingRuleMetadataFilter[]
    name string
    network string
    noAutomateDnsZone boolean
    portRange string
    pscConnectionId string
    pscConnectionStatus string
    pulumiLabels {[key: string]: string}
    selfLink string
    serviceDirectoryRegistrations GetGlobalForwardingRuleServiceDirectoryRegistration[]
    sourceIpRanges string[]
    subnetwork string
    target string
    project string
    allowPscGlobalAccess Boolean
    baseForwardingRule String
    description String
    effectiveLabels Map<String>
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    ipProtocol String
    ipVersion String
    labelFingerprint String
    labels Map<String>
    loadBalancingScheme String
    metadataFilters List<Property Map>
    name String
    network String
    noAutomateDnsZone Boolean
    portRange String
    pscConnectionId String
    pscConnectionStatus String
    pulumiLabels Map<String>
    selfLink String
    serviceDirectoryRegistrations List<Property Map>
    sourceIpRanges List<String>
    subnetwork String
    target String
    project String

    Supporting Types

    GetGlobalForwardingRuleMetadataFilter

    FilterLabels List<GetGlobalForwardingRuleMetadataFilterFilterLabel>

    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 filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

    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. Possible values: ["MATCH_ANY", "MATCH_ALL"]

    FilterLabels []GetGlobalForwardingRuleMetadataFilterFilterLabel

    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 filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

    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. Possible values: ["MATCH_ANY", "MATCH_ALL"]

    filterLabels List<GetGlobalForwardingRuleMetadataFilterFilterLabel>

    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 filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

    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. Possible values: ["MATCH_ANY", "MATCH_ALL"]

    filterLabels GetGlobalForwardingRuleMetadataFilterFilterLabel[]

    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 filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

    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. Possible values: ["MATCH_ANY", "MATCH_ALL"]

    filter_labels Sequence[GetGlobalForwardingRuleMetadataFilterFilterLabel]

    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 filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

    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. Possible values: ["MATCH_ANY", "MATCH_ALL"]

    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 filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

    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. Possible values: ["MATCH_ANY", "MATCH_ALL"]

    GetGlobalForwardingRuleMetadataFilterFilterLabel

    Name string
    The name of the global forwarding rule.


    Value string
    The value that the label must match. The value has a maximum length of 1024 characters.
    Name string
    The name of the global forwarding rule.


    Value string
    The value that the label must match. The value has a maximum length of 1024 characters.
    name String
    The name of the global forwarding rule.


    value String
    The value that the label must match. The value has a maximum length of 1024 characters.
    name string
    The name of the global forwarding rule.


    value string
    The value that the label must match. The value has a maximum length of 1024 characters.
    name str
    The name of the global forwarding rule.


    value str
    The value that the label must match. The value has a maximum length of 1024 characters.
    name String
    The name of the global forwarding rule.


    value String
    The value that the label must match. The value has a maximum length of 1024 characters.

    GetGlobalForwardingRuleServiceDirectoryRegistration

    Namespace string
    Service Directory namespace 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.
    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.
    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.
    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_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.
    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.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi