1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LoadBalancer
  5. getPathRouteSets
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

oci.LoadBalancer.getPathRouteSets

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    This data source provides the list of Path Route Sets in Oracle Cloud Infrastructure Load Balancer service.

    Lists all path route sets associated with the specified load balancer.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testPathRouteSets = oci.LoadBalancer.getPathRouteSets({
        loadBalancerId: testLoadBalancer.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_path_route_sets = oci.LoadBalancer.get_path_route_sets(load_balancer_id=test_load_balancer["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/LoadBalancer"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := LoadBalancer.GetPathRouteSets(ctx, &loadbalancer.GetPathRouteSetsArgs{
    			LoadBalancerId: testLoadBalancer.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testPathRouteSets = Oci.LoadBalancer.GetPathRouteSets.Invoke(new()
        {
            LoadBalancerId = testLoadBalancer.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.LoadBalancer.LoadBalancerFunctions;
    import com.pulumi.oci.LoadBalancer.inputs.GetPathRouteSetsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testPathRouteSets = LoadBalancerFunctions.getPathRouteSets(GetPathRouteSetsArgs.builder()
                .loadBalancerId(testLoadBalancer.id())
                .build());
    
        }
    }
    
    variables:
      testPathRouteSets:
        fn::invoke:
          Function: oci:LoadBalancer:getPathRouteSets
          Arguments:
            loadBalancerId: ${testLoadBalancer.id}
    

    Using getPathRouteSets

    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 getPathRouteSets(args: GetPathRouteSetsArgs, opts?: InvokeOptions): Promise<GetPathRouteSetsResult>
    function getPathRouteSetsOutput(args: GetPathRouteSetsOutputArgs, opts?: InvokeOptions): Output<GetPathRouteSetsResult>
    def get_path_route_sets(filters: Optional[Sequence[_loadbalancer.GetPathRouteSetsFilter]] = None,
                            load_balancer_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPathRouteSetsResult
    def get_path_route_sets_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_loadbalancer.GetPathRouteSetsFilterArgs]]]] = None,
                            load_balancer_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPathRouteSetsResult]
    func GetPathRouteSets(ctx *Context, args *GetPathRouteSetsArgs, opts ...InvokeOption) (*GetPathRouteSetsResult, error)
    func GetPathRouteSetsOutput(ctx *Context, args *GetPathRouteSetsOutputArgs, opts ...InvokeOption) GetPathRouteSetsResultOutput

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

    public static class GetPathRouteSets 
    {
        public static Task<GetPathRouteSetsResult> InvokeAsync(GetPathRouteSetsArgs args, InvokeOptions? opts = null)
        public static Output<GetPathRouteSetsResult> Invoke(GetPathRouteSetsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPathRouteSetsResult> getPathRouteSets(GetPathRouteSetsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:LoadBalancer/getPathRouteSets:getPathRouteSets
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LoadBalancerId string
    The OCID of the load balancer associated with the path route sets to retrieve.
    Filters List<GetPathRouteSetsFilter>
    LoadBalancerId string
    The OCID of the load balancer associated with the path route sets to retrieve.
    Filters []GetPathRouteSetsFilter
    loadBalancerId String
    The OCID of the load balancer associated with the path route sets to retrieve.
    filters List<GetPathRouteSetsFilter>
    loadBalancerId string
    The OCID of the load balancer associated with the path route sets to retrieve.
    filters GetPathRouteSetsFilter[]
    load_balancer_id str
    The OCID of the load balancer associated with the path route sets to retrieve.
    filters Sequence[loadbalancer.GetPathRouteSetsFilter]
    loadBalancerId String
    The OCID of the load balancer associated with the path route sets to retrieve.
    filters List<Property Map>

    getPathRouteSets Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerId string
    PathRouteSets List<GetPathRouteSetsPathRouteSet>
    The list of path_route_sets.
    Filters List<GetPathRouteSetsFilter>
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancerId string
    PathRouteSets []GetPathRouteSetsPathRouteSet
    The list of path_route_sets.
    Filters []GetPathRouteSetsFilter
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerId String
    pathRouteSets List<GetPathRouteSetsPathRouteSet>
    The list of path_route_sets.
    filters List<GetPathRouteSetsFilter>
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancerId string
    pathRouteSets GetPathRouteSetsPathRouteSet[]
    The list of path_route_sets.
    filters GetPathRouteSetsFilter[]
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancer_id str
    path_route_sets Sequence[loadbalancer.GetPathRouteSetsPathRouteSet]
    The list of path_route_sets.
    filters Sequence[loadbalancer.GetPathRouteSetsFilter]
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancerId String
    pathRouteSets List<Property Map>
    The list of path_route_sets.
    filters List<Property Map>

    Supporting Types

    GetPathRouteSetsFilter

    Name string
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    Values List<string>
    Regex bool
    Name string
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    Values []string
    Regex bool
    name String
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    values List<String>
    regex Boolean
    name string
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    values string[]
    regex boolean
    name str
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    values Sequence[str]
    regex bool
    name String
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    values List<String>
    regex Boolean

    GetPathRouteSetsPathRouteSet

    LoadBalancerId string
    The OCID of the load balancer associated with the path route sets to retrieve.
    Name string
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    PathRoutes List<GetPathRouteSetsPathRouteSetPathRoute>
    The set of path route rules.
    State string
    LoadBalancerId string
    The OCID of the load balancer associated with the path route sets to retrieve.
    Name string
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    PathRoutes []GetPathRouteSetsPathRouteSetPathRoute
    The set of path route rules.
    State string
    loadBalancerId String
    The OCID of the load balancer associated with the path route sets to retrieve.
    name String
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    pathRoutes List<GetPathRouteSetsPathRouteSetPathRoute>
    The set of path route rules.
    state String
    loadBalancerId string
    The OCID of the load balancer associated with the path route sets to retrieve.
    name string
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    pathRoutes GetPathRouteSetsPathRouteSetPathRoute[]
    The set of path route rules.
    state string
    load_balancer_id str
    The OCID of the load balancer associated with the path route sets to retrieve.
    name str
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    path_routes Sequence[loadbalancer.GetPathRouteSetsPathRouteSetPathRoute]
    The set of path route rules.
    state str
    loadBalancerId String
    The OCID of the load balancer associated with the path route sets to retrieve.
    name String
    The unique name for this set of path route rules. Avoid entering confidential information. Example: example_path_route_set
    pathRoutes List<Property Map>
    The set of path route rules.
    state String

    GetPathRouteSetsPathRouteSetPathRoute

    BackendSetName string
    The name of the target backend set for requests where the incoming URI matches the specified path. Example: example_backend_set
    Path string
    The path string to match against the incoming URI path.

    • Path strings are case-insensitive.
    • Asterisk (*) wildcards are not supported.
    • Regular expressions are not supported.
    PathMatchType GetPathRouteSetsPathRouteSetPathRoutePathMatchType
    The type of matching to apply to incoming URIs.
    BackendSetName string
    The name of the target backend set for requests where the incoming URI matches the specified path. Example: example_backend_set
    Path string
    The path string to match against the incoming URI path.

    • Path strings are case-insensitive.
    • Asterisk (*) wildcards are not supported.
    • Regular expressions are not supported.
    PathMatchType GetPathRouteSetsPathRouteSetPathRoutePathMatchType
    The type of matching to apply to incoming URIs.
    backendSetName String
    The name of the target backend set for requests where the incoming URI matches the specified path. Example: example_backend_set
    path String
    The path string to match against the incoming URI path.

    • Path strings are case-insensitive.
    • Asterisk (*) wildcards are not supported.
    • Regular expressions are not supported.
    pathMatchType GetPathRouteSetsPathRouteSetPathRoutePathMatchType
    The type of matching to apply to incoming URIs.
    backendSetName string
    The name of the target backend set for requests where the incoming URI matches the specified path. Example: example_backend_set
    path string
    The path string to match against the incoming URI path.

    • Path strings are case-insensitive.
    • Asterisk (*) wildcards are not supported.
    • Regular expressions are not supported.
    pathMatchType GetPathRouteSetsPathRouteSetPathRoutePathMatchType
    The type of matching to apply to incoming URIs.
    backend_set_name str
    The name of the target backend set for requests where the incoming URI matches the specified path. Example: example_backend_set
    path str
    The path string to match against the incoming URI path.

    • Path strings are case-insensitive.
    • Asterisk (*) wildcards are not supported.
    • Regular expressions are not supported.
    path_match_type loadbalancer.GetPathRouteSetsPathRouteSetPathRoutePathMatchType
    The type of matching to apply to incoming URIs.
    backendSetName String
    The name of the target backend set for requests where the incoming URI matches the specified path. Example: example_backend_set
    path String
    The path string to match against the incoming URI path.

    • Path strings are case-insensitive.
    • Asterisk (*) wildcards are not supported.
    • Regular expressions are not supported.
    pathMatchType Property Map
    The type of matching to apply to incoming URIs.

    GetPathRouteSetsPathRouteSetPathRoutePathMatchType

    MatchType string
    Specifies how the load balancing service compares a PathRoute object's path string against the incoming URI.

    • EXACT_MATCH - Looks for a path string that exactly matches the incoming URI path.
    • FORCE_LONGEST_PREFIX_MATCH - Looks for the path string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - Looks for a path string that matches the beginning portion of the incoming URI path.
    • SUFFIX_MATCH - Looks for a path string that matches the ending portion of the incoming URI path.
    MatchType string
    Specifies how the load balancing service compares a PathRoute object's path string against the incoming URI.

    • EXACT_MATCH - Looks for a path string that exactly matches the incoming URI path.
    • FORCE_LONGEST_PREFIX_MATCH - Looks for the path string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - Looks for a path string that matches the beginning portion of the incoming URI path.
    • SUFFIX_MATCH - Looks for a path string that matches the ending portion of the incoming URI path.
    matchType String
    Specifies how the load balancing service compares a PathRoute object's path string against the incoming URI.

    • EXACT_MATCH - Looks for a path string that exactly matches the incoming URI path.
    • FORCE_LONGEST_PREFIX_MATCH - Looks for the path string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - Looks for a path string that matches the beginning portion of the incoming URI path.
    • SUFFIX_MATCH - Looks for a path string that matches the ending portion of the incoming URI path.
    matchType string
    Specifies how the load balancing service compares a PathRoute object's path string against the incoming URI.

    • EXACT_MATCH - Looks for a path string that exactly matches the incoming URI path.
    • FORCE_LONGEST_PREFIX_MATCH - Looks for the path string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - Looks for a path string that matches the beginning portion of the incoming URI path.
    • SUFFIX_MATCH - Looks for a path string that matches the ending portion of the incoming URI path.
    match_type str
    Specifies how the load balancing service compares a PathRoute object's path string against the incoming URI.

    • EXACT_MATCH - Looks for a path string that exactly matches the incoming URI path.
    • FORCE_LONGEST_PREFIX_MATCH - Looks for the path string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - Looks for a path string that matches the beginning portion of the incoming URI path.
    • SUFFIX_MATCH - Looks for a path string that matches the ending portion of the incoming URI path.
    matchType String
    Specifies how the load balancing service compares a PathRoute object's path string against the incoming URI.

    • EXACT_MATCH - Looks for a path string that exactly matches the incoming URI path.
    • FORCE_LONGEST_PREFIX_MATCH - Looks for the path string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - Looks for a path string that matches the beginning portion of the incoming URI path.
    • SUFFIX_MATCH - Looks for a path string that matches the ending portion of the incoming URI path.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi