Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.LoadBalancer.getListenerRules

This data source provides the list of Listener Rules in Oracle Cloud Infrastructure Load Balancer service.

Lists all of the rules from all of the rule sets associated with the specified listener. The response organizes the rules in the following order:

Access control rules
Allow method rules
Request header rules
Response header rules

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testListenerRules = Oci.LoadBalancer.GetListenerRules.Invoke(new()
    {
        ListenerName = oci_load_balancer_listener.Test_listener.Name,
        LoadBalancerId = oci_load_balancer_load_balancer.Test_load_balancer.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/LoadBalancer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := LoadBalancer.GetListenerRules(ctx, &loadbalancer.GetListenerRulesArgs{
			ListenerName:   oci_load_balancer_listener.Test_listener.Name,
			LoadBalancerId: oci_load_balancer_load_balancer.Test_load_balancer.Id,
		}, 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.GetListenerRulesArgs;
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 testListenerRules = LoadBalancerFunctions.getListenerRules(GetListenerRulesArgs.builder()
            .listenerName(oci_load_balancer_listener.test_listener().name())
            .loadBalancerId(oci_load_balancer_load_balancer.test_load_balancer().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_listener_rules = oci.LoadBalancer.get_listener_rules(listener_name=oci_load_balancer_listener["test_listener"]["name"],
    load_balancer_id=oci_load_balancer_load_balancer["test_load_balancer"]["id"])

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testListenerRules = oci.LoadBalancer.getListenerRules({
    listenerName: oci_load_balancer_listener.test_listener.name,
    loadBalancerId: oci_load_balancer_load_balancer.test_load_balancer.id,
});

variables:
  testListenerRules:
    fn::invoke:
      Function: oci:LoadBalancer:getListenerRules
      Arguments:
        listenerName: ${oci_load_balancer_listener.test_listener.name}
        loadBalancerId: ${oci_load_balancer_load_balancer.test_load_balancer.id}

Using getListenerRules

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 getListenerRules(args: GetListenerRulesArgs, opts?: InvokeOptions): Promise<GetListenerRulesResult>
function getListenerRulesOutput(args: GetListenerRulesOutputArgs, opts?: InvokeOptions): Output<GetListenerRulesResult>

def get_listener_rules(filters: Optional[Sequence[_loadbalancer.GetListenerRulesFilter]] = None,
                       listener_name: Optional[str] = None,
                       load_balancer_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetListenerRulesResult
def get_listener_rules_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_loadbalancer.GetListenerRulesFilterArgs]]]] = None,
                       listener_name: Optional[pulumi.Input[str]] = None,
                       load_balancer_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetListenerRulesResult]

func GetListenerRules(ctx *Context, args *GetListenerRulesArgs, opts ...InvokeOption) (*GetListenerRulesResult, error)
func GetListenerRulesOutput(ctx *Context, args *GetListenerRulesOutputArgs, opts ...InvokeOption) GetListenerRulesResultOutput

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

public static class GetListenerRules 
{
    public static Task<GetListenerRulesResult> InvokeAsync(GetListenerRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetListenerRulesResult> Invoke(GetListenerRulesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetListenerRulesResult> getListenerRules(GetListenerRulesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:LoadBalancer/getListenerRules:getListenerRules
  arguments:
    # arguments dictionary

The following arguments are supported:

ListenerName string: The name of the listener the rules are associated with.
LoadBalancerId string: The OCID of the load balancer associated with the listener.
Filters List<GetListenerRulesFilter>

ListenerName string: The name of the listener the rules are associated with.
LoadBalancerId string: The OCID of the load balancer associated with the listener.
Filters []GetListenerRulesFilter

listenerName String: The name of the listener the rules are associated with.
loadBalancerId String: The OCID of the load balancer associated with the listener.
filters List<GetListenerRulesFilter>

listenerName string: The name of the listener the rules are associated with.
loadBalancerId string: The OCID of the load balancer associated with the listener.
filters GetListenerRulesFilter[]

listener_name str: The name of the listener the rules are associated with.
load_balancer_id str: The OCID of the load balancer associated with the listener.
filters GetListenerRulesFilter]

listenerName String: The name of the listener the rules are associated with.
loadBalancerId String: The OCID of the load balancer associated with the listener.
filters List<Property Map>

getListenerRules Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
ListenerName string
ListenerRules List<GetListenerRulesListenerRule>: The list of listener_rules.
LoadBalancerId string
Filters List<GetListenerRulesFilter>

Id string: The provider-assigned unique ID for this managed resource.
ListenerName string
ListenerRules []GetListenerRulesListenerRule: The list of listener_rules.
LoadBalancerId string
Filters []GetListenerRulesFilter

id String: The provider-assigned unique ID for this managed resource.
listenerName String
listenerRules List<GetListenerRulesListenerRule>: The list of listener_rules.
loadBalancerId String
filters List<GetListenerRulesFilter>

id string: The provider-assigned unique ID for this managed resource.
listenerName string
listenerRules GetListenerRulesListenerRule[]: The list of listener_rules.
loadBalancerId string
filters GetListenerRulesFilter[]

id str: The provider-assigned unique ID for this managed resource.
listener_name str
listener_rules GetListenerRulesListenerRule]: The list of listener_rules.
load_balancer_id str
filters GetListenerRulesFilter]

id String: The provider-assigned unique ID for this managed resource.
listenerName String
listenerRules List<Property Map>: The list of listener_rules.
loadBalancerId String
filters List<Property Map>

Supporting Types

GetListenerRulesFilter

Name string: The name of the rule set that the rule belongs to.
Values List<string>
Regex bool

Name string: The name of the rule set that the rule belongs to.
Values []string
Regex bool

name String: The name of the rule set that the rule belongs to.
values List<String>
regex Boolean

name string: The name of the rule set that the rule belongs to.
values string[]
regex boolean

name str: The name of the rule set that the rule belongs to.
values Sequence[str]
regex bool

name String: The name of the rule set that the rule belongs to.
values List<String>
regex Boolean

GetListenerRulesListenerRule

Name string: The name of the rule set that the rule belongs to.
Rules List<GetListenerRulesListenerRuleRule>: A rule object that applies to the listener.
State string

Name string: The name of the rule set that the rule belongs to.
Rules []GetListenerRulesListenerRuleRule: A rule object that applies to the listener.
State string

name String: The name of the rule set that the rule belongs to.
rules List<GetListenerRulesListenerRuleRule>: A rule object that applies to the listener.
state String

name string: The name of the rule set that the rule belongs to.
rules GetListenerRulesListenerRuleRule[]: A rule object that applies to the listener.
state string

name str: The name of the rule set that the rule belongs to.
rules GetListenerRulesListenerRuleRule]: A rule object that applies to the listener.
state str

name String: The name of the rule set that the rule belongs to.
rules List<Property Map>: A rule object that applies to the listener.
state String

GetListenerRulesListenerRuleRule

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<GetListenerRulesListenerRuleRuleCondition>

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<GetListenerRulesListenerRuleRuleRedirectUri>

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

AllowedMethods []string

The list of HTTP methods allowed for this listener.

AreInvalidCharactersAllowed bool

Conditions []GetListenerRulesListenerRuleRuleCondition

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 []GetListenerRulesListenerRuleRuleRedirectUri

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

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

allowedMethods List<String>

The list of HTTP methods allowed for this listener.

areInvalidCharactersAllowed Boolean

conditions List<GetListenerRulesListenerRuleRuleCondition>

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<GetListenerRulesListenerRuleRuleRedirectUri>

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

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

allowedMethods string[]

The list of HTTP methods allowed for this listener.

areInvalidCharactersAllowed boolean

conditions GetListenerRulesListenerRuleRuleCondition[]

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 GetListenerRulesListenerRuleRuleRedirectUri[]

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

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

allowed_methods Sequence[str]

The list of HTTP methods allowed for this listener.

are_invalid_characters_allowed bool

conditions GetListenerRulesListenerRuleRuleCondition]

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 GetListenerRulesListenerRuleRuleRedirectUri]

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

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

allowedMethods List<String>

The list of HTTP methods allowed for this listener.

areInvalidCharactersAllowed Boolean

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

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.

GetListenerRulesListenerRuleRuleCondition

AttributeName string

The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

AttributeValue string

The OCID of the originating VCN that an incoming packet must match.

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

The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

AttributeValue string

The OCID of the originating VCN that an incoming packet must match.

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

The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

attributeValue String

The OCID of the originating VCN that an incoming packet must match.

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

The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

attributeValue string

The OCID of the originating VCN that an incoming packet must match.

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

The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

attribute_value str

The OCID of the originating VCN that an incoming packet must match.

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

The attribute_name can be one of these values: PATH, SOURCE_IP_ADDRESS, SOURCE_VCN_ID, SOURCE_VCN_IP_ADDRESS

attributeValue String

The OCID of the originating VCN that an incoming packet must match.

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.

GetListenerRulesListenerRuleRuleRedirectUri

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.LoadBalancer.getListenerRules

Example Usage

Using getListenerRules

getListenerRules Result

Supporting Types

GetListenerRulesFilter

GetListenerRulesListenerRule

GetListenerRulesListenerRuleRule

GetListenerRulesListenerRuleRuleCondition

GetListenerRulesListenerRuleRuleRedirectUri

Package Details

Contents