Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
oci.LoadBalancer.getRuleSets
Explore with Pulumi AI
This data source provides the list of Rule Sets in Oracle Cloud Infrastructure Load Balancer service.
Lists all rule sets associated with the specified load balancer.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testRuleSets = oci.LoadBalancer.getRuleSets({
    loadBalancerId: testLoadBalancer.id,
});
import pulumi
import pulumi_oci as oci
test_rule_sets = oci.LoadBalancer.get_rule_sets(load_balancer_id=test_load_balancer["id"])
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/loadbalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := loadbalancer.GetRuleSets(ctx, &loadbalancer.GetRuleSetsArgs{
			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 testRuleSets = Oci.LoadBalancer.GetRuleSets.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.GetRuleSetsArgs;
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 testRuleSets = LoadBalancerFunctions.getRuleSets(GetRuleSetsArgs.builder()
            .loadBalancerId(testLoadBalancer.id())
            .build());
    }
}
variables:
  testRuleSets:
    fn::invoke:
      function: oci:LoadBalancer:getRuleSets
      arguments:
        loadBalancerId: ${testLoadBalancer.id}
Using getRuleSets
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 getRuleSets(args: GetRuleSetsArgs, opts?: InvokeOptions): Promise<GetRuleSetsResult>
function getRuleSetsOutput(args: GetRuleSetsOutputArgs, opts?: InvokeOptions): Output<GetRuleSetsResult>def get_rule_sets(filters: Optional[Sequence[_loadbalancer.GetRuleSetsFilter]] = None,
                  load_balancer_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetRuleSetsResult
def get_rule_sets_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_loadbalancer.GetRuleSetsFilterArgs]]]] = None,
                  load_balancer_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetRuleSetsResult]func GetRuleSets(ctx *Context, args *GetRuleSetsArgs, opts ...InvokeOption) (*GetRuleSetsResult, error)
func GetRuleSetsOutput(ctx *Context, args *GetRuleSetsOutputArgs, opts ...InvokeOption) GetRuleSetsResultOutput> Note: This function is named GetRuleSets in the Go SDK.
public static class GetRuleSets 
{
    public static Task<GetRuleSetsResult> InvokeAsync(GetRuleSetsArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleSetsResult> Invoke(GetRuleSetsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetRuleSetsResult> getRuleSets(GetRuleSetsArgs args, InvokeOptions options)
public static Output<GetRuleSetsResult> getRuleSets(GetRuleSetsArgs args, InvokeOptions options)
fn::invoke:
  function: oci:LoadBalancer/getRuleSets:getRuleSets
  arguments:
    # arguments dictionaryThe following arguments are supported:
- LoadBalancer stringId 
- The OCID of the specified load balancer.
- Filters
List<GetRule Sets Filter> 
- LoadBalancer stringId 
- The OCID of the specified load balancer.
- Filters
[]GetRule Sets Filter 
- loadBalancer StringId 
- The OCID of the specified load balancer.
- filters
List<GetRule Sets Filter> 
- loadBalancer stringId 
- The OCID of the specified load balancer.
- filters
GetRule Sets Filter[] 
- load_balancer_ strid 
- The OCID of the specified load balancer.
- filters
Sequence[loadbalancer.Get Rule Sets Filter] 
- loadBalancer StringId 
- The OCID of the specified load balancer.
- filters List<Property Map>
getRuleSets Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- LoadBalancer stringId 
- RuleSets List<GetRule Sets Rule Set> 
- The list of rule_sets.
- Filters
List<GetRule Sets Filter> 
- Id string
- The provider-assigned unique ID for this managed resource.
- LoadBalancer stringId 
- RuleSets []GetRule Sets Rule Set 
- The list of rule_sets.
- Filters
[]GetRule Sets Filter 
- id String
- The provider-assigned unique ID for this managed resource.
- loadBalancer StringId 
- ruleSets List<GetRule Sets Rule Set> 
- The list of rule_sets.
- filters
List<GetRule Sets Filter> 
- id string
- The provider-assigned unique ID for this managed resource.
- loadBalancer stringId 
- ruleSets GetRule Sets Rule Set[] 
- The list of rule_sets.
- filters
GetRule Sets Filter[] 
- id str
- The provider-assigned unique ID for this managed resource.
- load_balancer_ strid 
- rule_sets Sequence[loadbalancer.Get Rule Sets Rule Set] 
- The list of rule_sets.
- filters
Sequence[loadbalancer.Get Rule Sets Filter] 
- id String
- The provider-assigned unique ID for this managed resource.
- loadBalancer StringId 
- ruleSets List<Property Map>
- The list of rule_sets.
- filters List<Property Map>
Supporting Types
GetRuleSetsFilter   
GetRuleSetsRuleSet    
- Id string
- Items
List<GetRule Sets Rule Set Item> 
- An array of rules that compose the rule set.
- LoadBalancer stringId 
- The OCID of the specified load balancer.
- 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
[]GetRule Sets Rule Set Item 
- An array of rules that compose the rule set.
- LoadBalancer stringId 
- The OCID of the specified load balancer.
- 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<GetRule Sets Rule Set Item> 
- An array of rules that compose the rule set.
- loadBalancer StringId 
- The OCID of the specified load balancer.
- 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
GetRule Sets Rule Set Item[] 
- An array of rules that compose the rule set.
- loadBalancer stringId 
- The OCID of the specified load balancer.
- 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
Sequence[loadbalancer.Get Rule Sets Rule Set Item] 
- An array of rules that compose the rule set.
- load_balancer_ strid 
- The OCID of the specified load balancer.
- 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.
- loadBalancer StringId 
- The OCID of the specified load balancer.
- 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
GetRuleSetsRuleSetItem     
- 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,IP_BASED_MAX_CONNECTIONS,REDIRECT,REMOVE_HTTP_REQUEST_HEADER,REMOVE_HTTP_RESPONSE_HEADER
- AllowedMethods List<string>
- The list of HTTP methods allowed for this listener.
- AreInvalid boolCharacters Allowed 
- 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<GetRule Sets Rule Set Item Condition> 
- DefaultMax intConnections 
- The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited.
- 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
- HttpLarge intHeader Size In Kb 
- 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.
- IpMax List<GetConnections Rule Sets Rule Set Item Ip Max Connection> 
- An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
- 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.
 
- value cannot contain 
- RedirectUris List<GetRule Sets Rule Set Item Redirect Uri> 
- 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 cannot contain 
- 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.
 
- value cannot contain 
- 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,IP_BASED_MAX_CONNECTIONS,REDIRECT,REMOVE_HTTP_REQUEST_HEADER,REMOVE_HTTP_RESPONSE_HEADER
- AllowedMethods []string
- The list of HTTP methods allowed for this listener.
- AreInvalid boolCharacters Allowed 
- 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
[]GetRule Sets Rule Set Item Condition 
- DefaultMax intConnections 
- The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited.
- 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
- HttpLarge intHeader Size In Kb 
- 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.
- IpMax []GetConnections Rule Sets Rule Set Item Ip Max Connection 
- An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
- 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.
 
- value cannot contain 
- RedirectUris []GetRule Sets Rule Set Item Redirect Uri 
- 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 cannot contain 
- 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.
 
- value cannot contain 
- 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,IP_BASED_MAX_CONNECTIONS,REDIRECT,REMOVE_HTTP_REQUEST_HEADER,REMOVE_HTTP_RESPONSE_HEADER
- allowedMethods List<String>
- The list of HTTP methods allowed for this listener.
- areInvalid BooleanCharacters Allowed 
- 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<GetRule Sets Rule Set Item Condition> 
- defaultMax IntegerConnections 
- The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited.
- 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
- httpLarge IntegerHeader Size In Kb 
- 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.
- ipMax List<GetConnections Rule Sets Rule Set Item Ip Max Connection> 
- An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
- 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.
 
- value cannot contain 
- redirectUris List<GetRule Sets Rule Set Item Redirect Uri> 
- 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 cannot contain 
- 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.
 
- value cannot contain 
- 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,IP_BASED_MAX_CONNECTIONS,REDIRECT,REMOVE_HTTP_REQUEST_HEADER,REMOVE_HTTP_RESPONSE_HEADER
- allowedMethods string[]
- The list of HTTP methods allowed for this listener.
- areInvalid booleanCharacters Allowed 
- 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
GetRule Sets Rule Set Item Condition[] 
- defaultMax numberConnections 
- The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited.
- 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
- httpLarge numberHeader Size In Kb 
- 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.
- ipMax GetConnections Rule Sets Rule Set Item Ip Max Connection[] 
- An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
- 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.
 
- value cannot contain 
- redirectUris GetRule Sets Rule Set Item Redirect Uri[] 
- 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 cannot contain 
- 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.
 
- value cannot contain 
- 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,IP_BASED_MAX_CONNECTIONS,REDIRECT,REMOVE_HTTP_REQUEST_HEADER,REMOVE_HTTP_RESPONSE_HEADER
- allowed_methods Sequence[str]
- The list of HTTP methods allowed for this listener.
- are_invalid_ boolcharacters_ allowed 
- 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
Sequence[loadbalancer.Get Rule Sets Rule Set Item Condition] 
- default_max_ intconnections 
- The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited.
- 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_ intheader_ size_ in_ kb 
- 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.
- ip_max_ Sequence[loadbalancer.connections Get Rule Sets Rule Set Item Ip Max Connection] 
- An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
- 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.
 
- value cannot contain 
- redirect_uris Sequence[loadbalancer.Get Rule Sets Rule Set Item Redirect Uri] 
- 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 cannot contain 
- 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.
 
- value cannot contain 
- 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,IP_BASED_MAX_CONNECTIONS,REDIRECT,REMOVE_HTTP_REQUEST_HEADER,REMOVE_HTTP_RESPONSE_HEADER
- allowedMethods List<String>
- The list of HTTP methods allowed for this listener.
- areInvalid BooleanCharacters Allowed 
- 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>
- defaultMax NumberConnections 
- The maximum number of connections that the any IP can make to a listener unless the IP is mentioned in maxConnections. If no defaultMaxConnections is specified the default is unlimited.
- 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
- httpLarge NumberHeader Size In Kb 
- 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.
- ipMax List<Property Map>Connections 
- An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
- 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.
 
- value cannot contain 
- 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 cannot contain 
- 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.
 
- value cannot contain 
GetRuleSetsRuleSetItemCondition      
- 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
 
- when 
- Operator string
- A string that specifies how to compare the PathMatchCondition object's attributeValuestring to the incoming URI.- EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValuestring.
- FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValuestring 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 attributeValuestring.
- SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValuestring.
 
- EXACT_MATCH - The incoming URI path must exactly and completely match the 
- 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
 
- when 
- Operator string
- A string that specifies how to compare the PathMatchCondition object's attributeValuestring to the incoming URI.- EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValuestring.
- FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValuestring 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 attributeValuestring.
- SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValuestring.
 
- EXACT_MATCH - The incoming URI path must exactly and completely match the 
- 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
 
- when 
- operator String
- A string that specifies how to compare the PathMatchCondition object's attributeValuestring to the incoming URI.- EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValuestring.
- FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValuestring 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 attributeValuestring.
- SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValuestring.
 
- EXACT_MATCH - The incoming URI path must exactly and completely match the 
- 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
 
- when 
- operator string
- A string that specifies how to compare the PathMatchCondition object's attributeValuestring to the incoming URI.- EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValuestring.
- FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValuestring 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 attributeValuestring.
- SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValuestring.
 
- EXACT_MATCH - The incoming URI path must exactly and completely match the 
- 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
 
- when 
- operator str
- A string that specifies how to compare the PathMatchCondition object's attributeValuestring to the incoming URI.- EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValuestring.
- FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValuestring 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 attributeValuestring.
- SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValuestring.
 
- EXACT_MATCH - The incoming URI path must exactly and completely match the 
- 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
 
- when 
- operator String
- A string that specifies how to compare the PathMatchCondition object's attributeValuestring to the incoming URI.- EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValuestring.
- FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValuestring 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 attributeValuestring.
- SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValuestring.
 
- EXACT_MATCH - The incoming URI path must exactly and completely match the 
GetRuleSetsRuleSetItemIpMaxConnection        
- IpAddresses List<string>
- Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]'
- MaxConnections int
- The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener.
- IpAddresses []string
- Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]'
- MaxConnections int
- The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener.
- ipAddresses List<String>
- Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]'
- maxConnections Integer
- The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener.
- ipAddresses string[]
- Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]'
- maxConnections number
- The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener.
- ip_addresses Sequence[str]
- Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]'
- max_connections int
- The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener.
- ipAddresses List<String>
- Each element in the list should be valid IPv4 or IPv6 CIDR Block address. Example: '["129.213.176.0/24", "150.136.187.0/24", "2002::1234:abcd:ffff:c0a8:101/64"]'
- maxConnections Number
- The maximum number of simultaneous connections that the specified IPs can make to the Listener. IPs without a maxConnections setting can make either defaultMaxConnections simultaneous connections to a listener or, if no defaultMaxConnections is specified, an unlimited number of simultaneous connections to a listener.
GetRuleSetsRuleSetItemRedirectUri       
- 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 ociTerraform Provider.