1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LoadBalancer
  5. getRuleSet
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi

oci.LoadBalancer.getRuleSet

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.10.0 published on Thursday, Sep 7, 2023 by Pulumi

    This data source provides details about a specific Rule Set resource in Oracle Cloud Infrastructure Load Balancer service.

    Gets the specified set of rules.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testRuleSet = Oci.LoadBalancer.GetRuleSet.Invoke(new()
        {
            LoadBalancerId = oci_load_balancer_load_balancer.Test_load_balancer.Id,
            Name = @var.Rule_set_name,
        });
    
    });
    
    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.GetRuleSet(ctx, &loadbalancer.GetRuleSetArgs{
    			LoadBalancerId: oci_load_balancer_load_balancer.Test_load_balancer.Id,
    			Name:           _var.Rule_set_name,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.GetRuleSetArgs;
    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 testRuleSet = LoadBalancerFunctions.getRuleSet(GetRuleSetArgs.builder()
                .loadBalancerId(oci_load_balancer_load_balancer.test_load_balancer().id())
                .name(var_.rule_set_name())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_rule_set = oci.LoadBalancer.get_rule_set(load_balancer_id=oci_load_balancer_load_balancer["test_load_balancer"]["id"],
        name=var["rule_set_name"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testRuleSet = oci.LoadBalancer.getRuleSet({
        loadBalancerId: oci_load_balancer_load_balancer.test_load_balancer.id,
        name: _var.rule_set_name,
    });
    
    variables:
      testRuleSet:
        fn::invoke:
          Function: oci:LoadBalancer:getRuleSet
          Arguments:
            loadBalancerId: ${oci_load_balancer_load_balancer.test_load_balancer.id}
            name: ${var.rule_set_name}
    

    Using getRuleSet

    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 getRuleSet(args: GetRuleSetArgs, opts?: InvokeOptions): Promise<GetRuleSetResult>
    function getRuleSetOutput(args: GetRuleSetOutputArgs, opts?: InvokeOptions): Output<GetRuleSetResult>
    def get_rule_set(load_balancer_id: Optional[str] = None,
                     name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRuleSetResult
    def get_rule_set_output(load_balancer_id: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRuleSetResult]
    func GetRuleSet(ctx *Context, args *GetRuleSetArgs, opts ...InvokeOption) (*GetRuleSetResult, error)
    func GetRuleSetOutput(ctx *Context, args *GetRuleSetOutputArgs, opts ...InvokeOption) GetRuleSetResultOutput

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

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

    The following arguments are supported:

    LoadBalancerId string

    The OCID of the specified load balancer.

    Name string

    The name of the rule set to retrieve. Example: example_rule_set

    LoadBalancerId string

    The OCID of the specified load balancer.

    Name string

    The name of the rule set to retrieve. Example: example_rule_set

    loadBalancerId String

    The OCID of the specified load balancer.

    name String

    The name of the rule set to retrieve. Example: example_rule_set

    loadBalancerId string

    The OCID of the specified load balancer.

    name string

    The name of the rule set to retrieve. Example: example_rule_set

    load_balancer_id str

    The OCID of the specified load balancer.

    name str

    The name of the rule set to retrieve. Example: example_rule_set

    loadBalancerId String

    The OCID of the specified load balancer.

    name String

    The name of the rule set to retrieve. Example: example_rule_set

    getRuleSet Result

    The following output properties are available:

    Id string
    Items List<GetRuleSetItem>

    An array of rules that compose the rule set.

    LoadBalancerId string
    Name string

    The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_rule_set

    State string
    Id string
    Items []GetRuleSetItem

    An array of rules that compose the rule set.

    LoadBalancerId string
    Name string

    The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_rule_set

    State string
    id String
    items List<GetRuleSetItem>

    An array of rules that compose the rule set.

    loadBalancerId String
    name String

    The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_rule_set

    state String
    id string
    items GetRuleSetItem[]

    An array of rules that compose the rule set.

    loadBalancerId string
    name string

    The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_rule_set

    state string
    id str
    items GetRuleSetItem]

    An array of rules that compose the rule set.

    load_balancer_id str
    name str

    The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_rule_set

    state str
    id String
    items List<Property Map>

    An array of rules that compose the rule set.

    loadBalancerId String
    name String

    The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_rule_set

    state String

    Supporting Types

    GetRuleSetItem

    Action string

    The action can be one of these values: ADD_HTTP_REQUEST_HEADER, ADD_HTTP_RESPONSE_HEADER, ALLOW, CONTROL_ACCESS_USING_HTTP_METHODS, EXTEND_HTTP_REQUEST_HEADER_VALUE, EXTEND_HTTP_RESPONSE_HEADER_VALUE, HTTP_HEADER, REDIRECT, REMOVE_HTTP_REQUEST_HEADER, REMOVE_HTTP_RESPONSE_HEADER

    AllowedMethods List<string>

    The list of HTTP methods allowed for this listener.

    AreInvalidCharactersAllowed bool

    Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header

    Conditions List<GetRuleSetItemCondition>
    Description string

    A brief description of the access control rule. Avoid entering confidential information.

    Header string

    A header name that conforms to RFC 7230. Example: example_header_name

    HttpLargeHeaderSizeInKb int

    The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64.

    Prefix string

    A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    RedirectUris List<GetRuleSetItemRedirectUri>

    An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.

    ResponseCode int

    The HTTP status code to return when the incoming request is redirected.

    StatusCode int

    The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is 405 (Method Not Allowed). Example: 403

    Suffix string

    A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    Value string

    A header value that conforms to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    Action string

    The action can be one of these values: ADD_HTTP_REQUEST_HEADER, ADD_HTTP_RESPONSE_HEADER, ALLOW, CONTROL_ACCESS_USING_HTTP_METHODS, EXTEND_HTTP_REQUEST_HEADER_VALUE, EXTEND_HTTP_RESPONSE_HEADER_VALUE, HTTP_HEADER, REDIRECT, REMOVE_HTTP_REQUEST_HEADER, REMOVE_HTTP_RESPONSE_HEADER

    AllowedMethods []string

    The list of HTTP methods allowed for this listener.

    AreInvalidCharactersAllowed bool

    Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header

    Conditions []GetRuleSetItemCondition
    Description string

    A brief description of the access control rule. Avoid entering confidential information.

    Header string

    A header name that conforms to RFC 7230. Example: example_header_name

    HttpLargeHeaderSizeInKb int

    The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64.

    Prefix string

    A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    RedirectUris []GetRuleSetItemRedirectUri

    An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.

    ResponseCode int

    The HTTP status code to return when the incoming request is redirected.

    StatusCode int

    The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is 405 (Method Not Allowed). Example: 403

    Suffix string

    A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    Value string

    A header value that conforms to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    action String

    The action can be one of these values: ADD_HTTP_REQUEST_HEADER, ADD_HTTP_RESPONSE_HEADER, ALLOW, CONTROL_ACCESS_USING_HTTP_METHODS, EXTEND_HTTP_REQUEST_HEADER_VALUE, EXTEND_HTTP_RESPONSE_HEADER_VALUE, HTTP_HEADER, REDIRECT, REMOVE_HTTP_REQUEST_HEADER, REMOVE_HTTP_RESPONSE_HEADER

    allowedMethods List<String>

    The list of HTTP methods allowed for this listener.

    areInvalidCharactersAllowed Boolean

    Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header

    conditions List<GetRuleSetItemCondition>
    description String

    A brief description of the access control rule. Avoid entering confidential information.

    header String

    A header name that conforms to RFC 7230. Example: example_header_name

    httpLargeHeaderSizeInKb Integer

    The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64.

    prefix String

    A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    redirectUris List<GetRuleSetItemRedirectUri>

    An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.

    responseCode Integer

    The HTTP status code to return when the incoming request is redirected.

    statusCode Integer

    The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is 405 (Method Not Allowed). Example: 403

    suffix String

    A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    value String

    A header value that conforms to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    action string

    The action can be one of these values: ADD_HTTP_REQUEST_HEADER, ADD_HTTP_RESPONSE_HEADER, ALLOW, CONTROL_ACCESS_USING_HTTP_METHODS, EXTEND_HTTP_REQUEST_HEADER_VALUE, EXTEND_HTTP_RESPONSE_HEADER_VALUE, HTTP_HEADER, REDIRECT, REMOVE_HTTP_REQUEST_HEADER, REMOVE_HTTP_RESPONSE_HEADER

    allowedMethods string[]

    The list of HTTP methods allowed for this listener.

    areInvalidCharactersAllowed boolean

    Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header

    conditions GetRuleSetItemCondition[]
    description string

    A brief description of the access control rule. Avoid entering confidential information.

    header string

    A header name that conforms to RFC 7230. Example: example_header_name

    httpLargeHeaderSizeInKb number

    The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64.

    prefix string

    A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    redirectUris GetRuleSetItemRedirectUri[]

    An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.

    responseCode number

    The HTTP status code to return when the incoming request is redirected.

    statusCode number

    The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is 405 (Method Not Allowed). Example: 403

    suffix string

    A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    value string

    A header value that conforms to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    action str

    The action can be one of these values: ADD_HTTP_REQUEST_HEADER, ADD_HTTP_RESPONSE_HEADER, ALLOW, CONTROL_ACCESS_USING_HTTP_METHODS, EXTEND_HTTP_REQUEST_HEADER_VALUE, EXTEND_HTTP_RESPONSE_HEADER_VALUE, HTTP_HEADER, REDIRECT, REMOVE_HTTP_REQUEST_HEADER, REMOVE_HTTP_RESPONSE_HEADER

    allowed_methods Sequence[str]

    The list of HTTP methods allowed for this listener.

    are_invalid_characters_allowed bool

    Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header

    conditions GetRuleSetItemCondition]
    description str

    A brief description of the access control rule. Avoid entering confidential information.

    header str

    A header name that conforms to RFC 7230. Example: example_header_name

    http_large_header_size_in_kb int

    The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64.

    prefix str

    A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    redirect_uris GetRuleSetItemRedirectUri]

    An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.

    response_code int

    The HTTP status code to return when the incoming request is redirected.

    status_code int

    The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is 405 (Method Not Allowed). Example: 403

    suffix str

    A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    value str

    A header value that conforms to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    action String

    The action can be one of these values: ADD_HTTP_REQUEST_HEADER, ADD_HTTP_RESPONSE_HEADER, ALLOW, CONTROL_ACCESS_USING_HTTP_METHODS, EXTEND_HTTP_REQUEST_HEADER_VALUE, EXTEND_HTTP_RESPONSE_HEADER_VALUE, HTTP_HEADER, REDIRECT, REMOVE_HTTP_REQUEST_HEADER, REMOVE_HTTP_RESPONSE_HEADER

    allowedMethods List<String>

    The list of HTTP methods allowed for this listener.

    areInvalidCharactersAllowed Boolean

    Indicates whether or not invalid characters in client header fields will be allowed. Valid names are composed of English letters, digits, hyphens and underscores. If "true", invalid characters are allowed in the HTTP header. If "false", invalid characters are not allowed in the HTTP header

    conditions List<Property Map>
    description String

    A brief description of the access control rule. Avoid entering confidential information.

    header String

    A header name that conforms to RFC 7230. Example: example_header_name

    httpLargeHeaderSizeInKb Number

    The maximum size of each buffer used for reading http client request header. This value indicates the maximum size allowed for each buffer. The allowed values for buffer size are 8, 16, 32 and 64.

    prefix String

    A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    redirectUris List<Property Map>

    An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.

    responseCode Number

    The HTTP status code to return when the incoming request is redirected.

    statusCode Number

    The HTTP status code to return when the requested HTTP method is not in the list of allowed methods. The associated status line returned with the code is mapped from the standard HTTP specification. The default value is 405 (Method Not Allowed). Example: 403

    suffix String

    A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.
    value String

    A header value that conforms to RFC 7230. With the following exceptions:

    • value cannot contain $
    • value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.

    GetRuleSetItemCondition

    AttributeName string

    (Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

    AttributeValue string

    (Required) (Updatable) Depends on attribute_name:

    • when attribute_name = SOURCE_IP_ADDRESS | IPv4 or IPv6 address range to which the source IP address of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_IP_ADDRESS | IPv4 address range to which the original client IP address (in customer VCN) of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_ID | OCID of the customer VCN to which the service gateway embedded VCN ID of incoming packet would be matched against
    Operator string

    A string that specifies how to compare the PathMatchCondition object's attributeValue string to the incoming URI.

    • EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValue string.
    • FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValue string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - The beginning portion of the incoming URI path must exactly match the attributeValue string.
    • SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValue string.
    AttributeName string

    (Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

    AttributeValue string

    (Required) (Updatable) Depends on attribute_name:

    • when attribute_name = SOURCE_IP_ADDRESS | IPv4 or IPv6 address range to which the source IP address of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_IP_ADDRESS | IPv4 address range to which the original client IP address (in customer VCN) of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_ID | OCID of the customer VCN to which the service gateway embedded VCN ID of incoming packet would be matched against
    Operator string

    A string that specifies how to compare the PathMatchCondition object's attributeValue string to the incoming URI.

    • EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValue string.
    • FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValue string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - The beginning portion of the incoming URI path must exactly match the attributeValue string.
    • SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValue string.
    attributeName String

    (Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

    attributeValue String

    (Required) (Updatable) Depends on attribute_name:

    • when attribute_name = SOURCE_IP_ADDRESS | IPv4 or IPv6 address range to which the source IP address of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_IP_ADDRESS | IPv4 address range to which the original client IP address (in customer VCN) of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_ID | OCID of the customer VCN to which the service gateway embedded VCN ID of incoming packet would be matched against
    operator String

    A string that specifies how to compare the PathMatchCondition object's attributeValue string to the incoming URI.

    • EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValue string.
    • FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValue string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - The beginning portion of the incoming URI path must exactly match the attributeValue string.
    • SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValue string.
    attributeName string

    (Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

    attributeValue string

    (Required) (Updatable) Depends on attribute_name:

    • when attribute_name = SOURCE_IP_ADDRESS | IPv4 or IPv6 address range to which the source IP address of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_IP_ADDRESS | IPv4 address range to which the original client IP address (in customer VCN) of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_ID | OCID of the customer VCN to which the service gateway embedded VCN ID of incoming packet would be matched against
    operator string

    A string that specifies how to compare the PathMatchCondition object's attributeValue string to the incoming URI.

    • EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValue string.
    • FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValue string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - The beginning portion of the incoming URI path must exactly match the attributeValue string.
    • SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValue string.
    attribute_name str

    (Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

    attribute_value str

    (Required) (Updatable) Depends on attribute_name:

    • when attribute_name = SOURCE_IP_ADDRESS | IPv4 or IPv6 address range to which the source IP address of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_IP_ADDRESS | IPv4 address range to which the original client IP address (in customer VCN) of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_ID | OCID of the customer VCN to which the service gateway embedded VCN ID of incoming packet would be matched against
    operator str

    A string that specifies how to compare the PathMatchCondition object's attributeValue string to the incoming URI.

    • EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValue string.
    • FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValue string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - The beginning portion of the incoming URI path must exactly match the attributeValue string.
    • SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValue string.
    attributeName String

    (Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

    attributeValue String

    (Required) (Updatable) Depends on attribute_name:

    • when attribute_name = SOURCE_IP_ADDRESS | IPv4 or IPv6 address range to which the source IP address of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_IP_ADDRESS | IPv4 address range to which the original client IP address (in customer VCN) of incoming packet would be matched against
    • when attribute_name = SOURCE_VCN_ID | OCID of the customer VCN to which the service gateway embedded VCN ID of incoming packet would be matched against
    operator String

    A string that specifies how to compare the PathMatchCondition object's attributeValue string to the incoming URI.

    • EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValue string.
    • FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValue string with the best, longest match of the beginning portion of the incoming URI path.
    • PREFIX_MATCH - The beginning portion of the incoming URI path must exactly match the attributeValue string.
    • SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValue string.

    GetRuleSetItemRedirectUri

    Host string

    The valid domain name (hostname) or IP address to use in the redirect URI.

    Path string

    The HTTP URI path to use in the redirect URI.

    Port int

    The communication port to use in the redirect URI.

    Protocol string

    The HTTP protocol to use in the redirect URI.

    Query string

    The query string to use in the redirect URI.

    Host string

    The valid domain name (hostname) or IP address to use in the redirect URI.

    Path string

    The HTTP URI path to use in the redirect URI.

    Port int

    The communication port to use in the redirect URI.

    Protocol string

    The HTTP protocol to use in the redirect URI.

    Query string

    The query string to use in the redirect URI.

    host String

    The valid domain name (hostname) or IP address to use in the redirect URI.

    path String

    The HTTP URI path to use in the redirect URI.

    port Integer

    The communication port to use in the redirect URI.

    protocol String

    The HTTP protocol to use in the redirect URI.

    query String

    The query string to use in the redirect URI.

    host string

    The valid domain name (hostname) or IP address to use in the redirect URI.

    path string

    The HTTP URI path to use in the redirect URI.

    port number

    The communication port to use in the redirect URI.

    protocol string

    The HTTP protocol to use in the redirect URI.

    query string

    The query string to use in the redirect URI.

    host str

    The valid domain name (hostname) or IP address to use in the redirect URI.

    path str

    The HTTP URI path to use in the redirect URI.

    port int

    The communication port to use in the redirect URI.

    protocol str

    The HTTP protocol to use in the redirect URI.

    query str

    The query string to use in the redirect URI.

    host String

    The valid domain name (hostname) or IP address to use in the redirect URI.

    path String

    The HTTP URI path to use in the redirect URI.

    port Number

    The communication port to use in the redirect URI.

    protocol String

    The HTTP protocol to use in the redirect URI.

    query String

    The query string to use in the redirect URI.

    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.10.0 published on Thursday, Sep 7, 2023 by Pulumi