CreateListenerDetails¶

class oci.load_balancer.models.CreateListenerDetails(**kwargs)¶

Bases: object

The configuration details for adding a listener to a backend set. For more information on listener configuration, see Managing Load Balancer Listeners.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Methods

__init__(**kwargs) Initializes a new CreateListenerDetails object with values from keyword arguments.

Attributes

`connection_configuration`	Gets the connection_configuration of this CreateListenerDetails.
`default_backend_set_name`	[Required] Gets the default_backend_set_name of this CreateListenerDetails.
`hostname_names`	Gets the hostname_names of this CreateListenerDetails.
`name`	[Required] Gets the name of this CreateListenerDetails.
`path_route_set_name`	Gets the path_route_set_name of this CreateListenerDetails.
`port`	[Required] Gets the port of this CreateListenerDetails.
`protocol`	[Required] Gets the protocol of this CreateListenerDetails.
`routing_policy_name`	Gets the routing_policy_name of this CreateListenerDetails.
`rule_set_names`	Gets the rule_set_names of this CreateListenerDetails.
`ssl_configuration`	Gets the ssl_configuration of this CreateListenerDetails.

__init__(**kwargs)¶

Initializes a new CreateListenerDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

default_backend_set_name (str) – The value to assign to the default_backend_set_name property of this CreateListenerDetails.
port (int) – The value to assign to the port property of this CreateListenerDetails.
protocol (str) – The value to assign to the protocol property of this CreateListenerDetails.
hostname_names (list[str]) – The value to assign to the hostname_names property of this CreateListenerDetails.
path_route_set_name (str) – The value to assign to the path_route_set_name property of this CreateListenerDetails.
ssl_configuration (oci.load_balancer.models.SSLConfigurationDetails) – The value to assign to the ssl_configuration property of this CreateListenerDetails.
connection_configuration (oci.load_balancer.models.ConnectionConfiguration) – The value to assign to the connection_configuration property of this CreateListenerDetails.
name (str) – The value to assign to the name property of this CreateListenerDetails.
routing_policy_name (str) – The value to assign to the routing_policy_name property of this CreateListenerDetails.
rule_set_names (list[str]) – The value to assign to the rule_set_names property of this CreateListenerDetails.

connection_configuration¶

Gets the connection_configuration of this CreateListenerDetails.

Returns:	The connection_configuration of this CreateListenerDetails.
Return type:	oci.load_balancer.models.ConnectionConfiguration

default_backend_set_name¶

[Required] Gets the default_backend_set_name of this CreateListenerDetails. The name of the associated backend set.

Example: example_backend_set

Returns:	The default_backend_set_name of this CreateListenerDetails.
Return type:	str

hostname_names¶

Gets the hostname_names of this CreateListenerDetails. An array of hostname resource names.

Returns:	The hostname_names of this CreateListenerDetails.
Return type:	list[str]

name¶

[Required] Gets the name of this CreateListenerDetails. A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information.

Example: example_listener

Returns:	The name of this CreateListenerDetails.
Return type:	str

path_route_set_name¶

Gets the path_route_set_name of this CreateListenerDetails. Deprecated. Please use routingPolicies instead.

The name of the set of path-based routing rules, PathRouteSet, applied to this listener’s traffic.

Example: example_path_route_set

Returns:	The path_route_set_name of this CreateListenerDetails.
Return type:	str

port¶

[Required] Gets the port of this CreateListenerDetails. The communication port for the listener.

Example: 80

Returns:	The port of this CreateListenerDetails.
Return type:	int

protocol¶

[Required] Gets the protocol of this CreateListenerDetails. The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the list_protocols() operation.

Example: HTTP

Returns:	The protocol of this CreateListenerDetails.
Return type:	str

routing_policy_name¶

Gets the routing_policy_name of this CreateListenerDetails. The name of the routing policy applied to this listener’s traffic.

Example: example_routing_policy

Returns:	The routing_policy_name of this CreateListenerDetails.
Return type:	str

rule_set_names¶

Gets the rule_set_names of this CreateListenerDetails. The names of the RuleSet to apply to the listener.

Example: [“example_rule_set”]

Returns:	The rule_set_names of this CreateListenerDetails.
Return type:	list[str]

ssl_configuration¶

Gets the ssl_configuration of this CreateListenerDetails.

Returns:	The ssl_configuration of this CreateListenerDetails.
Return type:	oci.load_balancer.models.SSLConfigurationDetails