1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LoadBalancer
  5. getRuleSets
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.LoadBalancer.getRuleSets

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

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,
});
Copy
import pulumi
import pulumi_oci as oci

test_rule_sets = oci.LoadBalancer.get_rule_sets(load_balancer_id=test_load_balancer["id"])
Copy
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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
variables:
  testRuleSets:
    fn::invoke:
      function: oci:LoadBalancer:getRuleSets
      arguments:
        loadBalancerId: ${testLoadBalancer.id}
Copy

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>
Copy
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]
Copy
func GetRuleSets(ctx *Context, args *GetRuleSetsArgs, opts ...InvokeOption) (*GetRuleSetsResult, error)
func GetRuleSetsOutput(ctx *Context, args *GetRuleSetsOutputArgs, opts ...InvokeOption) GetRuleSetsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetRuleSetsResult> getRuleSets(GetRuleSetsArgs args, InvokeOptions options)
public static Output<GetRuleSetsResult> getRuleSets(GetRuleSetsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:LoadBalancer/getRuleSets:getRuleSets
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LoadBalancerId This property is required. string
The OCID of the specified load balancer.
Filters Changes to this property will trigger replacement. List<GetRuleSetsFilter>
LoadBalancerId This property is required. string
The OCID of the specified load balancer.
Filters Changes to this property will trigger replacement. []GetRuleSetsFilter
loadBalancerId This property is required. String
The OCID of the specified load balancer.
filters Changes to this property will trigger replacement. List<GetRuleSetsFilter>
loadBalancerId This property is required. string
The OCID of the specified load balancer.
filters Changes to this property will trigger replacement. GetRuleSetsFilter[]
load_balancer_id This property is required. str
The OCID of the specified load balancer.
filters Changes to this property will trigger replacement. Sequence[loadbalancer.GetRuleSetsFilter]
loadBalancerId This property is required. String
The OCID of the specified load balancer.
filters Changes to this property will trigger replacement. List<Property Map>

getRuleSets Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
LoadBalancerId string
RuleSets List<GetRuleSetsRuleSet>
The list of rule_sets.
Filters List<GetRuleSetsFilter>
Id string
The provider-assigned unique ID for this managed resource.
LoadBalancerId string
RuleSets []GetRuleSetsRuleSet
The list of rule_sets.
Filters []GetRuleSetsFilter
id String
The provider-assigned unique ID for this managed resource.
loadBalancerId String
ruleSets List<GetRuleSetsRuleSet>
The list of rule_sets.
filters List<GetRuleSetsFilter>
id string
The provider-assigned unique ID for this managed resource.
loadBalancerId string
ruleSets GetRuleSetsRuleSet[]
The list of rule_sets.
filters GetRuleSetsFilter[]
id str
The provider-assigned unique ID for this managed resource.
load_balancer_id str
rule_sets Sequence[loadbalancer.GetRuleSetsRuleSet]
The list of rule_sets.
filters Sequence[loadbalancer.GetRuleSetsFilter]
id String
The provider-assigned unique ID for this managed resource.
loadBalancerId String
ruleSets List<Property Map>
The list of rule_sets.
filters List<Property Map>

Supporting Types

GetRuleSetsFilter

Name This property is required. 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
Values This property is required. List<string>
Regex bool
Name This property is required. 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
Values This property is required. []string
Regex bool
name This property is required. 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
values This property is required. List<String>
regex Boolean
name This property is required. 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
values This property is required. string[]
regex boolean
name This property is required. 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
values This property is required. Sequence[str]
regex bool
name This property is required. 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
values This property is required. List<String>
regex Boolean

GetRuleSetsRuleSet

Id This property is required. string
Items This property is required. List<GetRuleSetsRuleSetItem>
An array of rules that compose the rule set.
LoadBalancerId This property is required. string
The OCID of the specified load balancer.
Name This property is required. 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 This property is required. string
Id This property is required. string
Items This property is required. []GetRuleSetsRuleSetItem
An array of rules that compose the rule set.
LoadBalancerId This property is required. string
The OCID of the specified load balancer.
Name This property is required. 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 This property is required. string
id This property is required. String
items This property is required. List<GetRuleSetsRuleSetItem>
An array of rules that compose the rule set.
loadBalancerId This property is required. String
The OCID of the specified load balancer.
name This property is required. 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 This property is required. String
id This property is required. string
items This property is required. GetRuleSetsRuleSetItem[]
An array of rules that compose the rule set.
loadBalancerId This property is required. string
The OCID of the specified load balancer.
name This property is required. 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 This property is required. string
id This property is required. str
items This property is required. Sequence[loadbalancer.GetRuleSetsRuleSetItem]
An array of rules that compose the rule set.
load_balancer_id This property is required. str
The OCID of the specified load balancer.
name This property is required. 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 This property is required. str
id This property is required. String
items This property is required. List<Property Map>
An array of rules that compose the rule set.
loadBalancerId This property is required. String
The OCID of the specified load balancer.
name This property is required. 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 This property is required. String

GetRuleSetsRuleSetItem

Action This property is required. 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 This property is required. List<string>
The list of HTTP methods allowed for this listener.
AreInvalidCharactersAllowed This property is required. 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 This property is required. List<GetRuleSetsRuleSetItemCondition>
DefaultMaxConnections This property is required. int
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 This property is required. string
A brief description of the access control rule. Avoid entering confidential information.
Header This property is required. string
A header name that conforms to RFC 7230. Example: example_header_name
HttpLargeHeaderSizeInKb This property is required. 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.
IpMaxConnections This property is required. List<GetRuleSetsRuleSetItemIpMaxConnection>
An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
Prefix This property is required. 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 This property is required. List<GetRuleSetsRuleSetItemRedirectUri>
An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.
ResponseCode This property is required. int
The HTTP status code to return when the incoming request is redirected.
StatusCode This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. []string
The list of HTTP methods allowed for this listener.
AreInvalidCharactersAllowed This property is required. 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 This property is required. []GetRuleSetsRuleSetItemCondition
DefaultMaxConnections This property is required. int
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 This property is required. string
A brief description of the access control rule. Avoid entering confidential information.
Header This property is required. string
A header name that conforms to RFC 7230. Example: example_header_name
HttpLargeHeaderSizeInKb This property is required. 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.
IpMaxConnections This property is required. []GetRuleSetsRuleSetItemIpMaxConnection
An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
Prefix This property is required. 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 This property is required. []GetRuleSetsRuleSetItemRedirectUri
An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.
ResponseCode This property is required. int
The HTTP status code to return when the incoming request is redirected.
StatusCode This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. List<String>
The list of HTTP methods allowed for this listener.
areInvalidCharactersAllowed This property is required. 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 This property is required. List<GetRuleSetsRuleSetItemCondition>
defaultMaxConnections This property is required. Integer
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 This property is required. String
A brief description of the access control rule. Avoid entering confidential information.
header This property is required. String
A header name that conforms to RFC 7230. Example: example_header_name
httpLargeHeaderSizeInKb This property is required. 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.
ipMaxConnections This property is required. List<GetRuleSetsRuleSetItemIpMaxConnection>
An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
prefix This property is required. 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 This property is required. List<GetRuleSetsRuleSetItemRedirectUri>
An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.
responseCode This property is required. Integer
The HTTP status code to return when the incoming request is redirected.
statusCode This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string[]
The list of HTTP methods allowed for this listener.
areInvalidCharactersAllowed This property is required. 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 This property is required. GetRuleSetsRuleSetItemCondition[]
defaultMaxConnections This property is required. number
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 This property is required. string
A brief description of the access control rule. Avoid entering confidential information.
header This property is required. string
A header name that conforms to RFC 7230. Example: example_header_name
httpLargeHeaderSizeInKb This property is required. 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.
ipMaxConnections This property is required. GetRuleSetsRuleSetItemIpMaxConnection[]
An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
prefix This property is required. 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 This property is required. GetRuleSetsRuleSetItemRedirectUri[]
An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.
responseCode This property is required. number
The HTTP status code to return when the incoming request is redirected.
statusCode This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. Sequence[str]
The list of HTTP methods allowed for this listener.
are_invalid_characters_allowed This property is required. 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 This property is required. Sequence[loadbalancer.GetRuleSetsRuleSetItemCondition]
default_max_connections This property is required. int
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 This property is required. str
A brief description of the access control rule. Avoid entering confidential information.
header This property is required. str
A header name that conforms to RFC 7230. Example: example_header_name
http_large_header_size_in_kb This property is required. 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.
ip_max_connections This property is required. Sequence[loadbalancer.GetRuleSetsRuleSetItemIpMaxConnection]
An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
prefix This property is required. 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 This property is required. Sequence[loadbalancer.GetRuleSetsRuleSetItemRedirectUri]
An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.
response_code This property is required. int
The HTTP status code to return when the incoming request is redirected.
status_code This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. List<String>
The list of HTTP methods allowed for this listener.
areInvalidCharactersAllowed This property is required. 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 This property is required. List<Property Map>
defaultMaxConnections This property is required. Number
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 This property is required. String
A brief description of the access control rule. Avoid entering confidential information.
header This property is required. String
A header name that conforms to RFC 7230. Example: example_header_name
httpLargeHeaderSizeInKb This property is required. 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.
ipMaxConnections This property is required. List<Property Map>
An array of IPs that have a maxConnection setting different than the default and what that maxConnection setting is
prefix This property is required. 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 This property is required. List<Property Map>
An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.
responseCode This property is required. Number
The HTTP status code to return when the incoming request is redirected.
statusCode This property is required. 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 This property is required. 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 This property is required. 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.

GetRuleSetsRuleSetItemCondition

AttributeName This property is required. string
(Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS
AttributeValue This property is required. 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 This property is required. 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 This property is required. string
(Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS
AttributeValue This property is required. 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 This property is required. 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 This property is required. String
(Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS
attributeValue This property is required. 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 This property is required. 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 This property is required. string
(Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS
attributeValue This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
(Required) (Updatable) The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS
attributeValue This property is required. 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 This property is required. 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.

GetRuleSetsRuleSetItemIpMaxConnection

IpAddresses This property is required. 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 This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
The valid domain name (hostname) or IP address to use in the redirect URI.
Path This property is required. string
The HTTP URI path to use in the redirect URI.
Port This property is required. int
The communication port to use in the redirect URI.
Protocol This property is required. string
The HTTP protocol to use in the redirect URI.
Query This property is required. string
The query string to use in the redirect URI.
Host This property is required. string
The valid domain name (hostname) or IP address to use in the redirect URI.
Path This property is required. string
The HTTP URI path to use in the redirect URI.
Port This property is required. int
The communication port to use in the redirect URI.
Protocol This property is required. string
The HTTP protocol to use in the redirect URI.
Query This property is required. string
The query string to use in the redirect URI.
host This property is required. String
The valid domain name (hostname) or IP address to use in the redirect URI.
path This property is required. String
The HTTP URI path to use in the redirect URI.
port This property is required. Integer
The communication port to use in the redirect URI.
protocol This property is required. String
The HTTP protocol to use in the redirect URI.
query This property is required. String
The query string to use in the redirect URI.
host This property is required. string
The valid domain name (hostname) or IP address to use in the redirect URI.
path This property is required. string
The HTTP URI path to use in the redirect URI.
port This property is required. number
The communication port to use in the redirect URI.
protocol This property is required. string
The HTTP protocol to use in the redirect URI.
query This property is required. string
The query string to use in the redirect URI.
host This property is required. str
The valid domain name (hostname) or IP address to use in the redirect URI.
path This property is required. str
The HTTP URI path to use in the redirect URI.
port This property is required. int
The communication port to use in the redirect URI.
protocol This property is required. str
The HTTP protocol to use in the redirect URI.
query This property is required. str
The query string to use in the redirect URI.
host This property is required. String
The valid domain name (hostname) or IP address to use in the redirect URI.
path This property is required. String
The HTTP URI path to use in the redirect URI.
port This property is required. Number
The communication port to use in the redirect URI.
protocol This property is required. String
The HTTP protocol to use in the redirect URI.
query This property is required. 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.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi