1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. LoadBalancer
  5. Listener
oci logo
Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.LoadBalancer.Listener

This resource provides the Listener resource in Oracle Cloud Infrastructure Load Balancer service.

Adds a listener to a load balancer.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testListener = new Oci.LoadBalancer.Listener("testListener", new()
    {
        DefaultBackendSetName = oci_load_balancer_backend_set.Test_backend_set.Name,
        LoadBalancerId = oci_load_balancer_load_balancer.Test_load_balancer.Id,
        Port = @var.Listener_port,
        Protocol = @var.Listener_protocol,
        ConnectionConfiguration = new Oci.LoadBalancer.Inputs.ListenerConnectionConfigurationArgs
        {
            IdleTimeoutInSeconds = @var.Listener_connection_configuration_idle_timeout_in_seconds,
            BackendTcpProxyProtocolVersion = @var.Listener_connection_configuration_backend_tcp_proxy_protocol_version,
        },
        HostnameNames = new[]
        {
            oci_load_balancer_hostname.Test_hostname.Name,
        },
        PathRouteSetName = oci_load_balancer_path_route_set.Test_path_route_set.Name,
        RoutingPolicyName = oci_load_balancer_load_balancer_routing_policy.Test_load_balancer_routing_policy.Name,
        RuleSetNames = new[]
        {
            oci_load_balancer_rule_set.Test_rule_set.Name,
        },
        SslConfiguration = new Oci.LoadBalancer.Inputs.ListenerSslConfigurationArgs
        {
            CertificateName = oci_load_balancer_certificate.Test_certificate.Name,
            CertificateIds = @var.Listener_ssl_configuration_certificate_ids,
            CipherSuiteName = @var.Listener_ssl_configuration_cipher_suite_name,
            Protocols = @var.Listener_ssl_configuration_protocols,
            ServerOrderPreference = @var.Listener_ssl_configuration_server_order_preference,
            TrustedCertificateAuthorityIds = @var.Listener_ssl_configuration_trusted_certificate_authority_ids,
            VerifyDepth = @var.Listener_ssl_configuration_verify_depth,
            VerifyPeerCertificate = @var.Listener_ssl_configuration_verify_peer_certificate,
        },
    });

});

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.NewListener(ctx, "testListener", &LoadBalancer.ListenerArgs{
			DefaultBackendSetName: pulumi.Any(oci_load_balancer_backend_set.Test_backend_set.Name),
			LoadBalancerId:        pulumi.Any(oci_load_balancer_load_balancer.Test_load_balancer.Id),
			Port:                  pulumi.Any(_var.Listener_port),
			Protocol:              pulumi.Any(_var.Listener_protocol),
			ConnectionConfiguration: &loadbalancer.ListenerConnectionConfigurationArgs{
				IdleTimeoutInSeconds:           pulumi.Any(_var.Listener_connection_configuration_idle_timeout_in_seconds),
				BackendTcpProxyProtocolVersion: pulumi.Any(_var.Listener_connection_configuration_backend_tcp_proxy_protocol_version),
			},
			HostnameNames: pulumi.StringArray{
				oci_load_balancer_hostname.Test_hostname.Name,
			},
			PathRouteSetName:  pulumi.Any(oci_load_balancer_path_route_set.Test_path_route_set.Name),
			RoutingPolicyName: pulumi.Any(oci_load_balancer_load_balancer_routing_policy.Test_load_balancer_routing_policy.Name),
			RuleSetNames: pulumi.StringArray{
				oci_load_balancer_rule_set.Test_rule_set.Name,
			},
			SslConfiguration: &loadbalancer.ListenerSslConfigurationArgs{
				CertificateName:                pulumi.Any(oci_load_balancer_certificate.Test_certificate.Name),
				CertificateIds:                 pulumi.Any(_var.Listener_ssl_configuration_certificate_ids),
				CipherSuiteName:                pulumi.Any(_var.Listener_ssl_configuration_cipher_suite_name),
				Protocols:                      pulumi.Any(_var.Listener_ssl_configuration_protocols),
				ServerOrderPreference:          pulumi.Any(_var.Listener_ssl_configuration_server_order_preference),
				TrustedCertificateAuthorityIds: pulumi.Any(_var.Listener_ssl_configuration_trusted_certificate_authority_ids),
				VerifyDepth:                    pulumi.Any(_var.Listener_ssl_configuration_verify_depth),
				VerifyPeerCertificate:          pulumi.Any(_var.Listener_ssl_configuration_verify_peer_certificate),
			},
		})
		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.Listener;
import com.pulumi.oci.LoadBalancer.ListenerArgs;
import com.pulumi.oci.LoadBalancer.inputs.ListenerConnectionConfigurationArgs;
import com.pulumi.oci.LoadBalancer.inputs.ListenerSslConfigurationArgs;
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) {
        var testListener = new Listener("testListener", ListenerArgs.builder()        
            .defaultBackendSetName(oci_load_balancer_backend_set.test_backend_set().name())
            .loadBalancerId(oci_load_balancer_load_balancer.test_load_balancer().id())
            .port(var_.listener_port())
            .protocol(var_.listener_protocol())
            .connectionConfiguration(ListenerConnectionConfigurationArgs.builder()
                .idleTimeoutInSeconds(var_.listener_connection_configuration_idle_timeout_in_seconds())
                .backendTcpProxyProtocolVersion(var_.listener_connection_configuration_backend_tcp_proxy_protocol_version())
                .build())
            .hostnameNames(oci_load_balancer_hostname.test_hostname().name())
            .pathRouteSetName(oci_load_balancer_path_route_set.test_path_route_set().name())
            .routingPolicyName(oci_load_balancer_load_balancer_routing_policy.test_load_balancer_routing_policy().name())
            .ruleSetNames(oci_load_balancer_rule_set.test_rule_set().name())
            .sslConfiguration(ListenerSslConfigurationArgs.builder()
                .certificateName(oci_load_balancer_certificate.test_certificate().name())
                .certificateIds(var_.listener_ssl_configuration_certificate_ids())
                .cipherSuiteName(var_.listener_ssl_configuration_cipher_suite_name())
                .protocols(var_.listener_ssl_configuration_protocols())
                .serverOrderPreference(var_.listener_ssl_configuration_server_order_preference())
                .trustedCertificateAuthorityIds(var_.listener_ssl_configuration_trusted_certificate_authority_ids())
                .verifyDepth(var_.listener_ssl_configuration_verify_depth())
                .verifyPeerCertificate(var_.listener_ssl_configuration_verify_peer_certificate())
                .build())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_listener = oci.load_balancer.Listener("testListener",
    default_backend_set_name=oci_load_balancer_backend_set["test_backend_set"]["name"],
    load_balancer_id=oci_load_balancer_load_balancer["test_load_balancer"]["id"],
    port=var["listener_port"],
    protocol=var["listener_protocol"],
    connection_configuration=oci.load_balancer.ListenerConnectionConfigurationArgs(
        idle_timeout_in_seconds=var["listener_connection_configuration_idle_timeout_in_seconds"],
        backend_tcp_proxy_protocol_version=var["listener_connection_configuration_backend_tcp_proxy_protocol_version"],
    ),
    hostname_names=[oci_load_balancer_hostname["test_hostname"]["name"]],
    path_route_set_name=oci_load_balancer_path_route_set["test_path_route_set"]["name"],
    routing_policy_name=oci_load_balancer_load_balancer_routing_policy["test_load_balancer_routing_policy"]["name"],
    rule_set_names=[oci_load_balancer_rule_set["test_rule_set"]["name"]],
    ssl_configuration=oci.load_balancer.ListenerSslConfigurationArgs(
        certificate_name=oci_load_balancer_certificate["test_certificate"]["name"],
        certificate_ids=var["listener_ssl_configuration_certificate_ids"],
        cipher_suite_name=var["listener_ssl_configuration_cipher_suite_name"],
        protocols=var["listener_ssl_configuration_protocols"],
        server_order_preference=var["listener_ssl_configuration_server_order_preference"],
        trusted_certificate_authority_ids=var["listener_ssl_configuration_trusted_certificate_authority_ids"],
        verify_depth=var["listener_ssl_configuration_verify_depth"],
        verify_peer_certificate=var["listener_ssl_configuration_verify_peer_certificate"],
    ))

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

const testListener = new oci.loadbalancer.Listener("testListener", {
    defaultBackendSetName: oci_load_balancer_backend_set.test_backend_set.name,
    loadBalancerId: oci_load_balancer_load_balancer.test_load_balancer.id,
    port: _var.listener_port,
    protocol: _var.listener_protocol,
    connectionConfiguration: {
        idleTimeoutInSeconds: _var.listener_connection_configuration_idle_timeout_in_seconds,
        backendTcpProxyProtocolVersion: _var.listener_connection_configuration_backend_tcp_proxy_protocol_version,
    },
    hostnameNames: [oci_load_balancer_hostname.test_hostname.name],
    pathRouteSetName: oci_load_balancer_path_route_set.test_path_route_set.name,
    routingPolicyName: oci_load_balancer_load_balancer_routing_policy.test_load_balancer_routing_policy.name,
    ruleSetNames: [oci_load_balancer_rule_set.test_rule_set.name],
    sslConfiguration: {
        certificateName: oci_load_balancer_certificate.test_certificate.name,
        certificateIds: _var.listener_ssl_configuration_certificate_ids,
        cipherSuiteName: _var.listener_ssl_configuration_cipher_suite_name,
        protocols: _var.listener_ssl_configuration_protocols,
        serverOrderPreference: _var.listener_ssl_configuration_server_order_preference,
        trustedCertificateAuthorityIds: _var.listener_ssl_configuration_trusted_certificate_authority_ids,
        verifyDepth: _var.listener_ssl_configuration_verify_depth,
        verifyPeerCertificate: _var.listener_ssl_configuration_verify_peer_certificate,
    },
});

resources:
  testListener:
    type: oci:LoadBalancer:Listener
    properties:
      #Required
      defaultBackendSetName: ${oci_load_balancer_backend_set.test_backend_set.name}
      loadBalancerId: ${oci_load_balancer_load_balancer.test_load_balancer.id}
      port: ${var.listener_port}
      protocol: ${var.listener_protocol}
      connectionConfiguration:
        idleTimeoutInSeconds: ${var.listener_connection_configuration_idle_timeout_in_seconds}
        backendTcpProxyProtocolVersion: ${var.listener_connection_configuration_backend_tcp_proxy_protocol_version}
      hostnameNames:
        - ${oci_load_balancer_hostname.test_hostname.name}
      pathRouteSetName: ${oci_load_balancer_path_route_set.test_path_route_set.name}
      routingPolicyName: ${oci_load_balancer_load_balancer_routing_policy.test_load_balancer_routing_policy.name}
      ruleSetNames:
        - ${oci_load_balancer_rule_set.test_rule_set.name}
      sslConfiguration:
        certificateName: ${oci_load_balancer_certificate.test_certificate.name}
        certificateIds: ${var.listener_ssl_configuration_certificate_ids}
        cipherSuiteName: ${var.listener_ssl_configuration_cipher_suite_name}
        protocols: ${var.listener_ssl_configuration_protocols}
        serverOrderPreference: ${var.listener_ssl_configuration_server_order_preference}
        trustedCertificateAuthorityIds: ${var.listener_ssl_configuration_trusted_certificate_authority_ids}
        verifyDepth: ${var.listener_ssl_configuration_verify_depth}
        verifyPeerCertificate: ${var.listener_ssl_configuration_verify_peer_certificate}

Create Listener Resource

new Listener(name: string, args: ListenerArgs, opts?: CustomResourceOptions);
@overload
def Listener(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             connection_configuration: Optional[_loadbalancer.ListenerConnectionConfigurationArgs] = None,
             default_backend_set_name: Optional[str] = None,
             hostname_names: Optional[Sequence[str]] = None,
             load_balancer_id: Optional[str] = None,
             name: Optional[str] = None,
             path_route_set_name: Optional[str] = None,
             port: Optional[int] = None,
             protocol: Optional[str] = None,
             routing_policy_name: Optional[str] = None,
             rule_set_names: Optional[Sequence[str]] = None,
             ssl_configuration: Optional[_loadbalancer.ListenerSslConfigurationArgs] = None)
@overload
def Listener(resource_name: str,
             args: ListenerArgs,
             opts: Optional[ResourceOptions] = None)
func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)
public Listener(string name, ListenerArgs args, CustomResourceOptions? opts = null)
public Listener(String name, ListenerArgs args)
public Listener(String name, ListenerArgs args, CustomResourceOptions options)

type: oci:LoadBalancer:Listener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ListenerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ListenerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ListenerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ListenerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ListenerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Listener Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Listener resource accepts the following input properties:

DefaultBackendSetName string

(Updatable) The name of the associated backend set. Example: example_backend_set

LoadBalancerId string

The OCID of the load balancer on which to add a listener.

Port int

(Updatable) The communication port for the listener. Example: 80

Protocol string

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

ConnectionConfiguration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

HostnameNames List<string>

(Updatable) An array of hostname resource names.

Name string

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

PathRouteSetName string

(Updatable) Deprecated. Please use routingPolicies instead.

RoutingPolicyName string

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

RuleSetNames List<string>

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

SslConfiguration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

DefaultBackendSetName string

(Updatable) The name of the associated backend set. Example: example_backend_set

LoadBalancerId string

The OCID of the load balancer on which to add a listener.

Port int

(Updatable) The communication port for the listener. Example: 80

Protocol string

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

ConnectionConfiguration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

HostnameNames []string

(Updatable) An array of hostname resource names.

Name string

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

PathRouteSetName string

(Updatable) Deprecated. Please use routingPolicies instead.

RoutingPolicyName string

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

RuleSetNames []string

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

SslConfiguration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

defaultBackendSetName String

(Updatable) The name of the associated backend set. Example: example_backend_set

loadBalancerId String

The OCID of the load balancer on which to add a listener.

port Integer

(Updatable) The communication port for the listener. Example: 80

protocol String

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

connectionConfiguration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

hostnameNames List<String>

(Updatable) An array of hostname resource names.

name String

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

pathRouteSetName String

(Updatable) Deprecated. Please use routingPolicies instead.

routingPolicyName String

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

ruleSetNames List<String>

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

sslConfiguration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

defaultBackendSetName string

(Updatable) The name of the associated backend set. Example: example_backend_set

loadBalancerId string

The OCID of the load balancer on which to add a listener.

port number

(Updatable) The communication port for the listener. Example: 80

protocol string

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

connectionConfiguration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

hostnameNames string[]

(Updatable) An array of hostname resource names.

name string

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

pathRouteSetName string

(Updatable) Deprecated. Please use routingPolicies instead.

routingPolicyName string

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

ruleSetNames string[]

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

sslConfiguration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

default_backend_set_name str

(Updatable) The name of the associated backend set. Example: example_backend_set

load_balancer_id str

The OCID of the load balancer on which to add a listener.

port int

(Updatable) The communication port for the listener. Example: 80

protocol str

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

connection_configuration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

hostname_names Sequence[str]

(Updatable) An array of hostname resource names.

name str

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

path_route_set_name str

(Updatable) Deprecated. Please use routingPolicies instead.

routing_policy_name str

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

rule_set_names Sequence[str]

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

ssl_configuration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

defaultBackendSetName String

(Updatable) The name of the associated backend set. Example: example_backend_set

loadBalancerId String

The OCID of the load balancer on which to add a listener.

port Number

(Updatable) The communication port for the listener. Example: 80

protocol String

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

connectionConfiguration Property Map

(Updatable) Configuration details for the connection between the client and backend servers.

hostnameNames List<String>

(Updatable) An array of hostname resource names.

name String

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

pathRouteSetName String

(Updatable) Deprecated. Please use routingPolicies instead.

routingPolicyName String

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

ruleSetNames List<String>

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

sslConfiguration Property Map

(Updatable) The load balancer's SSL handling configuration details.

Outputs

All input properties are implicitly available as output properties. Additionally, the Listener resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

State string
Id string

The provider-assigned unique ID for this managed resource.

State string
id String

The provider-assigned unique ID for this managed resource.

state String
id string

The provider-assigned unique ID for this managed resource.

state string
id str

The provider-assigned unique ID for this managed resource.

state str
id String

The provider-assigned unique ID for this managed resource.

state String

Look up Existing Listener Resource

Get an existing Listener resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ListenerState, opts?: CustomResourceOptions): Listener
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_configuration: Optional[_loadbalancer.ListenerConnectionConfigurationArgs] = None,
        default_backend_set_name: Optional[str] = None,
        hostname_names: Optional[Sequence[str]] = None,
        load_balancer_id: Optional[str] = None,
        name: Optional[str] = None,
        path_route_set_name: Optional[str] = None,
        port: Optional[int] = None,
        protocol: Optional[str] = None,
        routing_policy_name: Optional[str] = None,
        rule_set_names: Optional[Sequence[str]] = None,
        ssl_configuration: Optional[_loadbalancer.ListenerSslConfigurationArgs] = None,
        state: Optional[str] = None) -> Listener
func GetListener(ctx *Context, name string, id IDInput, state *ListenerState, opts ...ResourceOption) (*Listener, error)
public static Listener Get(string name, Input<string> id, ListenerState? state, CustomResourceOptions? opts = null)
public static Listener get(String name, Output<String> id, ListenerState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ConnectionConfiguration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

DefaultBackendSetName string

(Updatable) The name of the associated backend set. Example: example_backend_set

HostnameNames List<string>

(Updatable) An array of hostname resource names.

LoadBalancerId string

The OCID of the load balancer on which to add a listener.

Name string

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

PathRouteSetName string

(Updatable) Deprecated. Please use routingPolicies instead.

Port int

(Updatable) The communication port for the listener. Example: 80

Protocol string

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

RoutingPolicyName string

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

RuleSetNames List<string>

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

SslConfiguration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

State string
ConnectionConfiguration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

DefaultBackendSetName string

(Updatable) The name of the associated backend set. Example: example_backend_set

HostnameNames []string

(Updatable) An array of hostname resource names.

LoadBalancerId string

The OCID of the load balancer on which to add a listener.

Name string

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

PathRouteSetName string

(Updatable) Deprecated. Please use routingPolicies instead.

Port int

(Updatable) The communication port for the listener. Example: 80

Protocol string

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

RoutingPolicyName string

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

RuleSetNames []string

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

SslConfiguration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

State string
connectionConfiguration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

defaultBackendSetName String

(Updatable) The name of the associated backend set. Example: example_backend_set

hostnameNames List<String>

(Updatable) An array of hostname resource names.

loadBalancerId String

The OCID of the load balancer on which to add a listener.

name String

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

pathRouteSetName String

(Updatable) Deprecated. Please use routingPolicies instead.

port Integer

(Updatable) The communication port for the listener. Example: 80

protocol String

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

routingPolicyName String

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

ruleSetNames List<String>

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

sslConfiguration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

state String
connectionConfiguration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

defaultBackendSetName string

(Updatable) The name of the associated backend set. Example: example_backend_set

hostnameNames string[]

(Updatable) An array of hostname resource names.

loadBalancerId string

The OCID of the load balancer on which to add a listener.

name string

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

pathRouteSetName string

(Updatable) Deprecated. Please use routingPolicies instead.

port number

(Updatable) The communication port for the listener. Example: 80

protocol string

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

routingPolicyName string

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

ruleSetNames string[]

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

sslConfiguration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

state string
connection_configuration ListenerConnectionConfigurationArgs

(Updatable) Configuration details for the connection between the client and backend servers.

default_backend_set_name str

(Updatable) The name of the associated backend set. Example: example_backend_set

hostname_names Sequence[str]

(Updatable) An array of hostname resource names.

load_balancer_id str

The OCID of the load balancer on which to add a listener.

name str

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

path_route_set_name str

(Updatable) Deprecated. Please use routingPolicies instead.

port int

(Updatable) The communication port for the listener. Example: 80

protocol str

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

routing_policy_name str

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

rule_set_names Sequence[str]

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

ssl_configuration ListenerSslConfigurationArgs

(Updatable) The load balancer's SSL handling configuration details.

state str
connectionConfiguration Property Map

(Updatable) Configuration details for the connection between the client and backend servers.

defaultBackendSetName String

(Updatable) The name of the associated backend set. Example: example_backend_set

hostnameNames List<String>

(Updatable) An array of hostname resource names.

loadBalancerId String

The OCID of the load balancer on which to add a listener.

name String

A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener

pathRouteSetName String

(Updatable) Deprecated. Please use routingPolicies instead.

port Number

(Updatable) The communication port for the listener. Example: 80

protocol String

(Updatable) The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP

routingPolicyName String

(Updatable) The name of the routing policy applied to this listener's traffic. Example: example_routing_policy

ruleSetNames List<String>

(Updatable) The names of the rule sets to apply to the listener. Example: ["example_rule_set"]

sslConfiguration Property Map

(Updatable) The load balancer's SSL handling configuration details.

state String

Supporting Types

ListenerConnectionConfiguration

IdleTimeoutInSeconds string

(Updatable) The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations.

BackendTcpProxyProtocolVersion int

(Updatable) The backend TCP Proxy Protocol version. Example: 1

IdleTimeoutInSeconds string

(Updatable) The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations.

BackendTcpProxyProtocolVersion int

(Updatable) The backend TCP Proxy Protocol version. Example: 1

idleTimeoutInSeconds String

(Updatable) The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations.

backendTcpProxyProtocolVersion Integer

(Updatable) The backend TCP Proxy Protocol version. Example: 1

idleTimeoutInSeconds string

(Updatable) The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations.

backendTcpProxyProtocolVersion number

(Updatable) The backend TCP Proxy Protocol version. Example: 1

idle_timeout_in_seconds str

(Updatable) The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations.

backend_tcp_proxy_protocol_version int

(Updatable) The backend TCP Proxy Protocol version. Example: 1

idleTimeoutInSeconds String

(Updatable) The maximum idle time, in seconds, allowed between two successive receive or two successive send operations between the client and backend servers. A send operation does not reset the timer for receive operations. A receive operation does not reset the timer for send operations.

backendTcpProxyProtocolVersion Number

(Updatable) The backend TCP Proxy Protocol version. Example: 1

ListenerSslConfiguration

CertificateIds List<string>

(Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]

CertificateName string

(Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle

CipherSuiteName string

(Updatable) The name of the cipher suite to use for HTTPS or SSL connections.

Protocols List<string>

(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.

ServerOrderPreference string

(Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.

TrustedCertificateAuthorityIds List<string>

(Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]

VerifyDepth int

(Updatable) The maximum depth for peer certificate chain verification. Example: 3

VerifyPeerCertificate bool

(Updatable) Whether the load balancer listener should verify peer certificates. Example: true

CertificateIds []string

(Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]

CertificateName string

(Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle

CipherSuiteName string

(Updatable) The name of the cipher suite to use for HTTPS or SSL connections.

Protocols []string

(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.

ServerOrderPreference string

(Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.

TrustedCertificateAuthorityIds []string

(Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]

VerifyDepth int

(Updatable) The maximum depth for peer certificate chain verification. Example: 3

VerifyPeerCertificate bool

(Updatable) Whether the load balancer listener should verify peer certificates. Example: true

certificateIds List<String>

(Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]

certificateName String

(Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle

cipherSuiteName String

(Updatable) The name of the cipher suite to use for HTTPS or SSL connections.

protocols List<String>

(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.

serverOrderPreference String

(Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.

trustedCertificateAuthorityIds List<String>

(Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]

verifyDepth Integer

(Updatable) The maximum depth for peer certificate chain verification. Example: 3

verifyPeerCertificate Boolean

(Updatable) Whether the load balancer listener should verify peer certificates. Example: true

certificateIds string[]

(Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]

certificateName string

(Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle

cipherSuiteName string

(Updatable) The name of the cipher suite to use for HTTPS or SSL connections.

protocols string[]

(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.

serverOrderPreference string

(Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.

trustedCertificateAuthorityIds string[]

(Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]

verifyDepth number

(Updatable) The maximum depth for peer certificate chain verification. Example: 3

verifyPeerCertificate boolean

(Updatable) Whether the load balancer listener should verify peer certificates. Example: true

certificate_ids Sequence[str]

(Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]

certificate_name str

(Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle

cipher_suite_name str

(Updatable) The name of the cipher suite to use for HTTPS or SSL connections.

protocols Sequence[str]

(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.

server_order_preference str

(Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.

trusted_certificate_authority_ids Sequence[str]

(Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]

verify_depth int

(Updatable) The maximum depth for peer certificate chain verification. Example: 3

verify_peer_certificate bool

(Updatable) Whether the load balancer listener should verify peer certificates. Example: true

certificateIds List<String>

(Updatable) Ids for Oracle Cloud Infrastructure certificates service certificates. Currently only a single Id may be passed. Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]

certificateName String

(Updatable) A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information. Example: example_certificate_bundle

cipherSuiteName String

(Updatable) The name of the cipher suite to use for HTTPS or SSL connections.

protocols List<String>

(Updatable) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.

serverOrderPreference String

(Updatable) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.

trustedCertificateAuthorityIds List<String>

(Updatable) Ids for Oracle Cloud Infrastructure certificates service CA or CA bundles for the load balancer to trust. Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]

verifyDepth Number

(Updatable) The maximum depth for peer certificate chain verification. Example: 3

verifyPeerCertificate Boolean

(Updatable) Whether the load balancer listener should verify peer certificates. Example: true

Import

Listeners can be imported using the id, e.g.

 $ pulumi import oci:LoadBalancer/listener:Listener test_listener "loadBalancers/{loadBalancerId}/listeners/{listenerName}"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.