opentelekomcloud.LbListenerV3
Explore with Pulumi AI
Up-to-date reference of API arguments for DLB listener you can get at documentation portal
Manages a Dedicated LB listener resource within OpenTelekomCloud.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const listener1 = new opentelekomcloud.LbListenerV3("listener1", {
protocol: "HTTP",
protocolPort: 8080,
loadbalancerId: _var.loadbalancer_id,
tags: {
muh: "kuh",
},
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
listener1 = opentelekomcloud.LbListenerV3("listener1",
protocol="HTTP",
protocol_port=8080,
loadbalancer_id=var["loadbalancer_id"],
tags={
"muh": "kuh",
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := opentelekomcloud.NewLbListenerV3(ctx, "listener1", &opentelekomcloud.LbListenerV3Args{
Protocol: pulumi.String("HTTP"),
ProtocolPort: pulumi.Float64(8080),
LoadbalancerId: pulumi.Any(_var.Loadbalancer_id),
Tags: pulumi.StringMap{
"muh": pulumi.String("kuh"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var listener1 = new Opentelekomcloud.LbListenerV3("listener1", new()
{
Protocol = "HTTP",
ProtocolPort = 8080,
LoadbalancerId = @var.Loadbalancer_id,
Tags =
{
{ "muh", "kuh" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.LbListenerV3;
import com.pulumi.opentelekomcloud.LbListenerV3Args;
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 listener1 = new LbListenerV3("listener1", LbListenerV3Args.builder()
.protocol("HTTP")
.protocolPort(8080)
.loadbalancerId(var_.loadbalancer_id())
.tags(Map.of("muh", "kuh"))
.build());
}
}
resources:
listener1:
type: opentelekomcloud:LbListenerV3
properties:
protocol: HTTP
protocolPort: 8080
loadbalancerId: ${var.loadbalancer_id}
tags:
muh: kuh
Example Ip Address Group
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const group1 = new opentelekomcloud.LbIpgroupV3("group1", {
description: "some interesting description 2",
ipLists: [{
ip: "192.168.10.11",
description: "one",
}],
});
const listener1 = new opentelekomcloud.LbListenerV3("listener1", {
description: "some interesting description",
loadbalancerId: opentelekomcloud_lb_loadbalancer_v3.loadbalancer_1.id,
protocol: "HTTP",
protocolPort: 8080,
advancedForwarding: true,
sniMatchAlgo: "wildcard",
insertHeaders: {
forwardedHost: true,
},
ipGroup: {
id: group1.lbIpgroupV3Id,
enable: true,
},
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
group1 = opentelekomcloud.LbIpgroupV3("group1",
description="some interesting description 2",
ip_lists=[{
"ip": "192.168.10.11",
"description": "one",
}])
listener1 = opentelekomcloud.LbListenerV3("listener1",
description="some interesting description",
loadbalancer_id=opentelekomcloud_lb_loadbalancer_v3["loadbalancer_1"]["id"],
protocol="HTTP",
protocol_port=8080,
advanced_forwarding=True,
sni_match_algo="wildcard",
insert_headers={
"forwarded_host": True,
},
ip_group={
"id": group1.lb_ipgroup_v3_id,
"enable": True,
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
group1, err := opentelekomcloud.NewLbIpgroupV3(ctx, "group1", &opentelekomcloud.LbIpgroupV3Args{
Description: pulumi.String("some interesting description 2"),
IpLists: opentelekomcloud.LbIpgroupV3IpListArray{
&opentelekomcloud.LbIpgroupV3IpListArgs{
Ip: pulumi.String("192.168.10.11"),
Description: pulumi.String("one"),
},
},
})
if err != nil {
return err
}
_, err = opentelekomcloud.NewLbListenerV3(ctx, "listener1", &opentelekomcloud.LbListenerV3Args{
Description: pulumi.String("some interesting description"),
LoadbalancerId: pulumi.Any(opentelekomcloud_lb_loadbalancer_v3.Loadbalancer_1.Id),
Protocol: pulumi.String("HTTP"),
ProtocolPort: pulumi.Float64(8080),
AdvancedForwarding: pulumi.Bool(true),
SniMatchAlgo: pulumi.String("wildcard"),
InsertHeaders: &opentelekomcloud.LbListenerV3InsertHeadersArgs{
ForwardedHost: pulumi.Bool(true),
},
IpGroup: &opentelekomcloud.LbListenerV3IpGroupArgs{
Id: group1.LbIpgroupV3Id,
Enable: pulumi.Bool(true),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var group1 = new Opentelekomcloud.LbIpgroupV3("group1", new()
{
Description = "some interesting description 2",
IpLists = new[]
{
new Opentelekomcloud.Inputs.LbIpgroupV3IpListArgs
{
Ip = "192.168.10.11",
Description = "one",
},
},
});
var listener1 = new Opentelekomcloud.LbListenerV3("listener1", new()
{
Description = "some interesting description",
LoadbalancerId = opentelekomcloud_lb_loadbalancer_v3.Loadbalancer_1.Id,
Protocol = "HTTP",
ProtocolPort = 8080,
AdvancedForwarding = true,
SniMatchAlgo = "wildcard",
InsertHeaders = new Opentelekomcloud.Inputs.LbListenerV3InsertHeadersArgs
{
ForwardedHost = true,
},
IpGroup = new Opentelekomcloud.Inputs.LbListenerV3IpGroupArgs
{
Id = group1.LbIpgroupV3Id,
Enable = true,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.LbIpgroupV3;
import com.pulumi.opentelekomcloud.LbIpgroupV3Args;
import com.pulumi.opentelekomcloud.inputs.LbIpgroupV3IpListArgs;
import com.pulumi.opentelekomcloud.LbListenerV3;
import com.pulumi.opentelekomcloud.LbListenerV3Args;
import com.pulumi.opentelekomcloud.inputs.LbListenerV3InsertHeadersArgs;
import com.pulumi.opentelekomcloud.inputs.LbListenerV3IpGroupArgs;
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 group1 = new LbIpgroupV3("group1", LbIpgroupV3Args.builder()
.description("some interesting description 2")
.ipLists(LbIpgroupV3IpListArgs.builder()
.ip("192.168.10.11")
.description("one")
.build())
.build());
var listener1 = new LbListenerV3("listener1", LbListenerV3Args.builder()
.description("some interesting description")
.loadbalancerId(opentelekomcloud_lb_loadbalancer_v3.loadbalancer_1().id())
.protocol("HTTP")
.protocolPort(8080)
.advancedForwarding(true)
.sniMatchAlgo("wildcard")
.insertHeaders(LbListenerV3InsertHeadersArgs.builder()
.forwardedHost(true)
.build())
.ipGroup(LbListenerV3IpGroupArgs.builder()
.id(group1.lbIpgroupV3Id())
.enable(true)
.build())
.build());
}
}
resources:
group1:
type: opentelekomcloud:LbIpgroupV3
properties:
description: some interesting description 2
ipLists:
- ip: 192.168.10.11
description: one
listener1:
type: opentelekomcloud:LbListenerV3
properties:
description: some interesting description
loadbalancerId: ${opentelekomcloud_lb_loadbalancer_v3.loadbalancer_1.id}
protocol: HTTP
protocolPort: 8080
advancedForwarding: true
sniMatchAlgo: wildcard
insertHeaders:
forwardedHost: true
ipGroup:
id: ${group1.lbIpgroupV3Id}
enable: true
Create LbListenerV3 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LbListenerV3(name: string, args: LbListenerV3Args, opts?: CustomResourceOptions);
@overload
def LbListenerV3(resource_name: str,
args: LbListenerV3Args,
opts: Optional[ResourceOptions] = None)
@overload
def LbListenerV3(resource_name: str,
opts: Optional[ResourceOptions] = None,
loadbalancer_id: Optional[str] = None,
protocol_port: Optional[float] = None,
protocol: Optional[str] = None,
keep_alive_timeout: Optional[float] = None,
client_timeout: Optional[float] = None,
default_tls_container_ref: Optional[str] = None,
description: Optional[str] = None,
http2_enable: Optional[bool] = None,
insert_headers: Optional[LbListenerV3InsertHeadersArgs] = None,
ip_group: Optional[LbListenerV3IpGroupArgs] = None,
admin_state_up: Optional[bool] = None,
lb_listener_v3_id: Optional[str] = None,
default_pool_id: Optional[str] = None,
member_retry_enable: Optional[bool] = None,
member_timeout: Optional[float] = None,
name: Optional[str] = None,
client_ca_tls_container_ref: Optional[str] = None,
advanced_forwarding: Optional[bool] = None,
security_policy_id: Optional[str] = None,
sni_container_refs: Optional[Sequence[str]] = None,
sni_match_algo: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tls_ciphers_policy: Optional[str] = None)
func NewLbListenerV3(ctx *Context, name string, args LbListenerV3Args, opts ...ResourceOption) (*LbListenerV3, error)
public LbListenerV3(string name, LbListenerV3Args args, CustomResourceOptions? opts = null)
public LbListenerV3(String name, LbListenerV3Args args)
public LbListenerV3(String name, LbListenerV3Args args, CustomResourceOptions options)
type: opentelekomcloud:LbListenerV3
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args LbListenerV3Args
- 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 LbListenerV3Args
- 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 LbListenerV3Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LbListenerV3Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LbListenerV3Args
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var lbListenerV3Resource = new Opentelekomcloud.LbListenerV3("lbListenerV3Resource", new()
{
LoadbalancerId = "string",
ProtocolPort = 0,
Protocol = "string",
KeepAliveTimeout = 0,
ClientTimeout = 0,
DefaultTlsContainerRef = "string",
Description = "string",
Http2Enable = false,
InsertHeaders = new Opentelekomcloud.Inputs.LbListenerV3InsertHeadersArgs
{
ForwardElbIp = false,
ForwardedForPort = false,
ForwardedHost = false,
ForwardedPort = false,
},
IpGroup = new Opentelekomcloud.Inputs.LbListenerV3IpGroupArgs
{
Id = "string",
Enable = false,
Type = "string",
},
AdminStateUp = false,
LbListenerV3Id = "string",
DefaultPoolId = "string",
MemberRetryEnable = false,
MemberTimeout = 0,
Name = "string",
ClientCaTlsContainerRef = "string",
AdvancedForwarding = false,
SecurityPolicyId = "string",
SniContainerRefs = new[]
{
"string",
},
SniMatchAlgo = "string",
Tags =
{
{ "string", "string" },
},
TlsCiphersPolicy = "string",
});
example, err := opentelekomcloud.NewLbListenerV3(ctx, "lbListenerV3Resource", &opentelekomcloud.LbListenerV3Args{
LoadbalancerId: pulumi.String("string"),
ProtocolPort: pulumi.Float64(0),
Protocol: pulumi.String("string"),
KeepAliveTimeout: pulumi.Float64(0),
ClientTimeout: pulumi.Float64(0),
DefaultTlsContainerRef: pulumi.String("string"),
Description: pulumi.String("string"),
Http2Enable: pulumi.Bool(false),
InsertHeaders: &opentelekomcloud.LbListenerV3InsertHeadersArgs{
ForwardElbIp: pulumi.Bool(false),
ForwardedForPort: pulumi.Bool(false),
ForwardedHost: pulumi.Bool(false),
ForwardedPort: pulumi.Bool(false),
},
IpGroup: &opentelekomcloud.LbListenerV3IpGroupArgs{
Id: pulumi.String("string"),
Enable: pulumi.Bool(false),
Type: pulumi.String("string"),
},
AdminStateUp: pulumi.Bool(false),
LbListenerV3Id: pulumi.String("string"),
DefaultPoolId: pulumi.String("string"),
MemberRetryEnable: pulumi.Bool(false),
MemberTimeout: pulumi.Float64(0),
Name: pulumi.String("string"),
ClientCaTlsContainerRef: pulumi.String("string"),
AdvancedForwarding: pulumi.Bool(false),
SecurityPolicyId: pulumi.String("string"),
SniContainerRefs: pulumi.StringArray{
pulumi.String("string"),
},
SniMatchAlgo: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TlsCiphersPolicy: pulumi.String("string"),
})
var lbListenerV3Resource = new LbListenerV3("lbListenerV3Resource", LbListenerV3Args.builder()
.loadbalancerId("string")
.protocolPort(0)
.protocol("string")
.keepAliveTimeout(0)
.clientTimeout(0)
.defaultTlsContainerRef("string")
.description("string")
.http2Enable(false)
.insertHeaders(LbListenerV3InsertHeadersArgs.builder()
.forwardElbIp(false)
.forwardedForPort(false)
.forwardedHost(false)
.forwardedPort(false)
.build())
.ipGroup(LbListenerV3IpGroupArgs.builder()
.id("string")
.enable(false)
.type("string")
.build())
.adminStateUp(false)
.lbListenerV3Id("string")
.defaultPoolId("string")
.memberRetryEnable(false)
.memberTimeout(0)
.name("string")
.clientCaTlsContainerRef("string")
.advancedForwarding(false)
.securityPolicyId("string")
.sniContainerRefs("string")
.sniMatchAlgo("string")
.tags(Map.of("string", "string"))
.tlsCiphersPolicy("string")
.build());
lb_listener_v3_resource = opentelekomcloud.LbListenerV3("lbListenerV3Resource",
loadbalancer_id="string",
protocol_port=0,
protocol="string",
keep_alive_timeout=0,
client_timeout=0,
default_tls_container_ref="string",
description="string",
http2_enable=False,
insert_headers={
"forward_elb_ip": False,
"forwarded_for_port": False,
"forwarded_host": False,
"forwarded_port": False,
},
ip_group={
"id": "string",
"enable": False,
"type": "string",
},
admin_state_up=False,
lb_listener_v3_id="string",
default_pool_id="string",
member_retry_enable=False,
member_timeout=0,
name="string",
client_ca_tls_container_ref="string",
advanced_forwarding=False,
security_policy_id="string",
sni_container_refs=["string"],
sni_match_algo="string",
tags={
"string": "string",
},
tls_ciphers_policy="string")
const lbListenerV3Resource = new opentelekomcloud.LbListenerV3("lbListenerV3Resource", {
loadbalancerId: "string",
protocolPort: 0,
protocol: "string",
keepAliveTimeout: 0,
clientTimeout: 0,
defaultTlsContainerRef: "string",
description: "string",
http2Enable: false,
insertHeaders: {
forwardElbIp: false,
forwardedForPort: false,
forwardedHost: false,
forwardedPort: false,
},
ipGroup: {
id: "string",
enable: false,
type: "string",
},
adminStateUp: false,
lbListenerV3Id: "string",
defaultPoolId: "string",
memberRetryEnable: false,
memberTimeout: 0,
name: "string",
clientCaTlsContainerRef: "string",
advancedForwarding: false,
securityPolicyId: "string",
sniContainerRefs: ["string"],
sniMatchAlgo: "string",
tags: {
string: "string",
},
tlsCiphersPolicy: "string",
});
type: opentelekomcloud:LbListenerV3
properties:
adminStateUp: false
advancedForwarding: false
clientCaTlsContainerRef: string
clientTimeout: 0
defaultPoolId: string
defaultTlsContainerRef: string
description: string
http2Enable: false
insertHeaders:
forwardElbIp: false
forwardedForPort: false
forwardedHost: false
forwardedPort: false
ipGroup:
enable: false
id: string
type: string
keepAliveTimeout: 0
lbListenerV3Id: string
loadbalancerId: string
memberRetryEnable: false
memberTimeout: 0
name: string
protocol: string
protocolPort: 0
securityPolicyId: string
sniContainerRefs:
- string
sniMatchAlgo: string
tags:
string: string
tlsCiphersPolicy: string
LbListenerV3 Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LbListenerV3 resource accepts the following input properties:
- Loadbalancer
Id string - Specifies the ID of the load balancer that the listener is added to.
- Protocol string
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - Protocol
Port double - Specifies the port used by the listener. Changing this creates a new Listener.
- Admin
State boolUp - Advanced
Forwarding bool - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - Client
Ca stringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- Client
Timeout double - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Default
Pool stringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- Default
Tls stringContainer Ref - Specifies the ID of the server certificate used by the listener.
- Description string
- Provides supplementary information about the listener.
- Http2Enable bool
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - Insert
Headers LbListener V3Insert Headers - Specifies the HTTP header fields.
- Ip
Group LbListener V3Ip Group - Specifies the IP address group associated with the listener.
- Keep
Alive doubleTimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- Lb
Listener stringV3Id - Member
Retry boolEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Member
Timeout double - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Name string
- Specifies the listener name.
- Security
Policy stringId - Specifies the ID of the custom security policy.
- Sni
Container List<string>Refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - Sni
Match stringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- Dictionary<string, string>
- Tags key/value pairs to associate with the loadbalancer listener.
- Tls
Ciphers stringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
.
- Loadbalancer
Id string - Specifies the ID of the load balancer that the listener is added to.
- Protocol string
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - Protocol
Port float64 - Specifies the port used by the listener. Changing this creates a new Listener.
- Admin
State boolUp - Advanced
Forwarding bool - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - Client
Ca stringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- Client
Timeout float64 - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Default
Pool stringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- Default
Tls stringContainer Ref - Specifies the ID of the server certificate used by the listener.
- Description string
- Provides supplementary information about the listener.
- Http2Enable bool
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - Insert
Headers LbListener V3Insert Headers Args - Specifies the HTTP header fields.
- Ip
Group LbListener V3Ip Group Args - Specifies the IP address group associated with the listener.
- Keep
Alive float64Timeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- Lb
Listener stringV3Id - Member
Retry boolEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Member
Timeout float64 - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Name string
- Specifies the listener name.
- Security
Policy stringId - Specifies the ID of the custom security policy.
- Sni
Container []stringRefs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - Sni
Match stringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- map[string]string
- Tags key/value pairs to associate with the loadbalancer listener.
- Tls
Ciphers stringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
.
- loadbalancer
Id String - Specifies the ID of the load balancer that the listener is added to.
- protocol String
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - protocol
Port Double - Specifies the port used by the listener. Changing this creates a new Listener.
- admin
State BooleanUp - advanced
Forwarding Boolean - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - client
Ca StringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- client
Timeout Double - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - default
Pool StringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- default
Tls StringContainer Ref - Specifies the ID of the server certificate used by the listener.
- description String
- Provides supplementary information about the listener.
- http2Enable Boolean
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - insert
Headers LbListener V3Insert Headers - Specifies the HTTP header fields.
- ip
Group LbListener V3Ip Group - Specifies the IP address group associated with the listener.
- keep
Alive DoubleTimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- lb
Listener StringV3Id - member
Retry BooleanEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - member
Timeout Double - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - name String
- Specifies the listener name.
- security
Policy StringId - Specifies the ID of the custom security policy.
- sni
Container List<String>Refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - sni
Match StringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- Map<String,String>
- Tags key/value pairs to associate with the loadbalancer listener.
- tls
Ciphers StringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
.
- loadbalancer
Id string - Specifies the ID of the load balancer that the listener is added to.
- protocol string
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - protocol
Port number - Specifies the port used by the listener. Changing this creates a new Listener.
- admin
State booleanUp - advanced
Forwarding boolean - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - client
Ca stringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- client
Timeout number - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - default
Pool stringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- default
Tls stringContainer Ref - Specifies the ID of the server certificate used by the listener.
- description string
- Provides supplementary information about the listener.
- http2Enable boolean
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - insert
Headers LbListener V3Insert Headers - Specifies the HTTP header fields.
- ip
Group LbListener V3Ip Group - Specifies the IP address group associated with the listener.
- keep
Alive numberTimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- lb
Listener stringV3Id - member
Retry booleanEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - member
Timeout number - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - name string
- Specifies the listener name.
- security
Policy stringId - Specifies the ID of the custom security policy.
- sni
Container string[]Refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - sni
Match stringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- {[key: string]: string}
- Tags key/value pairs to associate with the loadbalancer listener.
- tls
Ciphers stringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
.
- loadbalancer_
id str - Specifies the ID of the load balancer that the listener is added to.
- protocol str
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - protocol_
port float - Specifies the port used by the listener. Changing this creates a new Listener.
- admin_
state_ boolup - advanced_
forwarding bool - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - client_
ca_ strtls_ container_ ref - Specifies the ID of the CA certificate used by the listener.
- client_
timeout float - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - default_
pool_ strid - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- default_
tls_ strcontainer_ ref - Specifies the ID of the server certificate used by the listener.
- description str
- Provides supplementary information about the listener.
- http2_
enable bool - Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - insert_
headers LbListener V3Insert Headers Args - Specifies the HTTP header fields.
- ip_
group LbListener V3Ip Group Args - Specifies the IP address group associated with the listener.
- keep_
alive_ floattimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- lb_
listener_ strv3_ id - member_
retry_ boolenable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - member_
timeout float - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - name str
- Specifies the listener name.
- security_
policy_ strid - Specifies the ID of the custom security policy.
- sni_
container_ Sequence[str]refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - sni_
match_ stralgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- Mapping[str, str]
- Tags key/value pairs to associate with the loadbalancer listener.
- tls_
ciphers_ strpolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
.
- loadbalancer
Id String - Specifies the ID of the load balancer that the listener is added to.
- protocol String
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - protocol
Port Number - Specifies the port used by the listener. Changing this creates a new Listener.
- admin
State BooleanUp - advanced
Forwarding Boolean - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - client
Ca StringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- client
Timeout Number - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - default
Pool StringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- default
Tls StringContainer Ref - Specifies the ID of the server certificate used by the listener.
- description String
- Provides supplementary information about the listener.
- http2Enable Boolean
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - insert
Headers Property Map - Specifies the HTTP header fields.
- ip
Group Property Map - Specifies the IP address group associated with the listener.
- keep
Alive NumberTimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- lb
Listener StringV3Id - member
Retry BooleanEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - member
Timeout Number - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - name String
- Specifies the listener name.
- security
Policy StringId - Specifies the ID of the custom security policy.
- sni
Container List<String>Refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - sni
Match StringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- Map<String>
- Tags key/value pairs to associate with the loadbalancer listener.
- tls
Ciphers StringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
.
Outputs
All input properties are implicitly available as output properties. Additionally, the LbListenerV3 resource produces the following output properties:
- created_
at str - Indicates the creation time.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - Indicates the update time.
Look up Existing LbListenerV3 Resource
Get an existing LbListenerV3 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?: LbListenerV3State, opts?: CustomResourceOptions): LbListenerV3
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
admin_state_up: Optional[bool] = None,
advanced_forwarding: Optional[bool] = None,
client_ca_tls_container_ref: Optional[str] = None,
client_timeout: Optional[float] = None,
created_at: Optional[str] = None,
default_pool_id: Optional[str] = None,
default_tls_container_ref: Optional[str] = None,
description: Optional[str] = None,
http2_enable: Optional[bool] = None,
insert_headers: Optional[LbListenerV3InsertHeadersArgs] = None,
ip_group: Optional[LbListenerV3IpGroupArgs] = None,
keep_alive_timeout: Optional[float] = None,
lb_listener_v3_id: Optional[str] = None,
loadbalancer_id: Optional[str] = None,
member_retry_enable: Optional[bool] = None,
member_timeout: Optional[float] = None,
name: Optional[str] = None,
protocol: Optional[str] = None,
protocol_port: Optional[float] = None,
security_policy_id: Optional[str] = None,
sni_container_refs: Optional[Sequence[str]] = None,
sni_match_algo: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tls_ciphers_policy: Optional[str] = None,
updated_at: Optional[str] = None) -> LbListenerV3
func GetLbListenerV3(ctx *Context, name string, id IDInput, state *LbListenerV3State, opts ...ResourceOption) (*LbListenerV3, error)
public static LbListenerV3 Get(string name, Input<string> id, LbListenerV3State? state, CustomResourceOptions? opts = null)
public static LbListenerV3 get(String name, Output<String> id, LbListenerV3State state, CustomResourceOptions options)
resources: _: type: opentelekomcloud:LbListenerV3 get: id: ${id}
- 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.
- Admin
State boolUp - Advanced
Forwarding bool - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - Client
Ca stringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- Client
Timeout double - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Created
At string - Indicates the creation time.
- Default
Pool stringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- Default
Tls stringContainer Ref - Specifies the ID of the server certificate used by the listener.
- Description string
- Provides supplementary information about the listener.
- Http2Enable bool
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - Insert
Headers LbListener V3Insert Headers - Specifies the HTTP header fields.
- Ip
Group LbListener V3Ip Group - Specifies the IP address group associated with the listener.
- Keep
Alive doubleTimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- Lb
Listener stringV3Id - Loadbalancer
Id string - Specifies the ID of the load balancer that the listener is added to.
- Member
Retry boolEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Member
Timeout double - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Name string
- Specifies the listener name.
- Protocol string
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - Protocol
Port double - Specifies the port used by the listener. Changing this creates a new Listener.
- Security
Policy stringId - Specifies the ID of the custom security policy.
- Sni
Container List<string>Refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - Sni
Match stringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- Dictionary<string, string>
- Tags key/value pairs to associate with the loadbalancer listener.
- Tls
Ciphers stringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
. - Updated
At string - Indicates the update time.
- Admin
State boolUp - Advanced
Forwarding bool - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - Client
Ca stringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- Client
Timeout float64 - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Created
At string - Indicates the creation time.
- Default
Pool stringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- Default
Tls stringContainer Ref - Specifies the ID of the server certificate used by the listener.
- Description string
- Provides supplementary information about the listener.
- Http2Enable bool
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - Insert
Headers LbListener V3Insert Headers Args - Specifies the HTTP header fields.
- Ip
Group LbListener V3Ip Group Args - Specifies the IP address group associated with the listener.
- Keep
Alive float64Timeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- Lb
Listener stringV3Id - Loadbalancer
Id string - Specifies the ID of the load balancer that the listener is added to.
- Member
Retry boolEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Member
Timeout float64 - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - Name string
- Specifies the listener name.
- Protocol string
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - Protocol
Port float64 - Specifies the port used by the listener. Changing this creates a new Listener.
- Security
Policy stringId - Specifies the ID of the custom security policy.
- Sni
Container []stringRefs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - Sni
Match stringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- map[string]string
- Tags key/value pairs to associate with the loadbalancer listener.
- Tls
Ciphers stringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
. - Updated
At string - Indicates the update time.
- admin
State BooleanUp - advanced
Forwarding Boolean - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - client
Ca StringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- client
Timeout Double - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - created
At String - Indicates the creation time.
- default
Pool StringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- default
Tls StringContainer Ref - Specifies the ID of the server certificate used by the listener.
- description String
- Provides supplementary information about the listener.
- http2Enable Boolean
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - insert
Headers LbListener V3Insert Headers - Specifies the HTTP header fields.
- ip
Group LbListener V3Ip Group - Specifies the IP address group associated with the listener.
- keep
Alive DoubleTimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- lb
Listener StringV3Id - loadbalancer
Id String - Specifies the ID of the load balancer that the listener is added to.
- member
Retry BooleanEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - member
Timeout Double - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - name String
- Specifies the listener name.
- protocol String
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - protocol
Port Double - Specifies the port used by the listener. Changing this creates a new Listener.
- security
Policy StringId - Specifies the ID of the custom security policy.
- sni
Container List<String>Refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - sni
Match StringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- Map<String,String>
- Tags key/value pairs to associate with the loadbalancer listener.
- tls
Ciphers StringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
. - updated
At String - Indicates the update time.
- admin
State booleanUp - advanced
Forwarding boolean - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - client
Ca stringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- client
Timeout number - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - created
At string - Indicates the creation time.
- default
Pool stringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- default
Tls stringContainer Ref - Specifies the ID of the server certificate used by the listener.
- description string
- Provides supplementary information about the listener.
- http2Enable boolean
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - insert
Headers LbListener V3Insert Headers - Specifies the HTTP header fields.
- ip
Group LbListener V3Ip Group - Specifies the IP address group associated with the listener.
- keep
Alive numberTimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- lb
Listener stringV3Id - loadbalancer
Id string - Specifies the ID of the load balancer that the listener is added to.
- member
Retry booleanEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - member
Timeout number - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - name string
- Specifies the listener name.
- protocol string
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - protocol
Port number - Specifies the port used by the listener. Changing this creates a new Listener.
- security
Policy stringId - Specifies the ID of the custom security policy.
- sni
Container string[]Refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - sni
Match stringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- {[key: string]: string}
- Tags key/value pairs to associate with the loadbalancer listener.
- tls
Ciphers stringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
. - updated
At string - Indicates the update time.
- admin_
state_ boolup - advanced_
forwarding bool - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - client_
ca_ strtls_ container_ ref - Specifies the ID of the CA certificate used by the listener.
- client_
timeout float - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - created_
at str - Indicates the creation time.
- default_
pool_ strid - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- default_
tls_ strcontainer_ ref - Specifies the ID of the server certificate used by the listener.
- description str
- Provides supplementary information about the listener.
- http2_
enable bool - Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - insert_
headers LbListener V3Insert Headers Args - Specifies the HTTP header fields.
- ip_
group LbListener V3Ip Group Args - Specifies the IP address group associated with the listener.
- keep_
alive_ floattimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- lb_
listener_ strv3_ id - loadbalancer_
id str - Specifies the ID of the load balancer that the listener is added to.
- member_
retry_ boolenable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - member_
timeout float - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - name str
- Specifies the listener name.
- protocol str
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - protocol_
port float - Specifies the port used by the listener. Changing this creates a new Listener.
- security_
policy_ strid - Specifies the ID of the custom security policy.
- sni_
container_ Sequence[str]refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - sni_
match_ stralgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- Mapping[str, str]
- Tags key/value pairs to associate with the loadbalancer listener.
- tls_
ciphers_ strpolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
. - updated_
at str - Indicates the update time.
- admin
State BooleanUp - advanced
Forwarding Boolean - Specifies whether to enable advanced forwarding.
If advanced forwarding is enabled, more flexible forwarding policies and rules are supported.
The value can be
true
(enable advanced forwarding) orfalse
(disable advanced forwarding), and the default value isfalse
. Changing this creates a new Listener. - client
Ca StringTls Container Ref - Specifies the ID of the CA certificate used by the listener.
- client
Timeout Number - Specifies the timeout duration for waiting for a request from a client, in seconds.
This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - created
At String - Indicates the creation time.
- default
Pool StringId - Specifies the ID of the default backend server group. If there is no matched forwarding policy, requests are forwarded to the default backend server for processing.
- default
Tls StringContainer Ref - Specifies the ID of the server certificate used by the listener.
- description String
- Provides supplementary information about the listener.
- http2Enable Boolean
- Specifies whether to use HTTP/2. This parameter is available only for
HTTPS
listeners. If you configure this parameter for other types of listeners, it will not take effect. Enable HTTP/2 if you want the clients to use HTTP/2 to communicate with the load balancer. However, connections between the load balancer and backend servers use HTTP/1.x by default. - insert
Headers Property Map - Specifies the HTTP header fields.
- ip
Group Property Map - Specifies the IP address group associated with the listener.
- keep
Alive NumberTimeout - Specifies the idle timeout duration, in seconds.
- For
TCP
listeners, the value ranges from10
to4000
, and the default value is300
. - For
HTTP
andHTTPS
listeners, the value ranges from0
to4000
, and the default value is60
. - For
UDP
listeners, this parameter is not available. An error will be returned if you configure this parameter forUDP
listeners.
- For
- lb
Listener StringV3Id - loadbalancer
Id String - Specifies the ID of the load balancer that the listener is added to.
- member
Retry BooleanEnable - Specifies whether to enable health check retries for backend servers.
This parameter is available only for
HTTP
andHTTPS
listeners. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - member
Timeout Number - Specifies the timeout duration for waiting for a request from a
backend server, in seconds. This parameter is available only for
HTTP
andHTTPS
listeners. The value ranges from1
to300
, and the default value is60
. An error will be returned if you configure this parameter forTCP
andUDP
listeners. - name String
- Specifies the listener name.
- protocol String
- The protocol - can either be
TCP
,HTTP
,HTTPS
orUDP
. Changing this creates a new Listener. - protocol
Port Number - Specifies the port used by the listener. Changing this creates a new Listener.
- security
Policy StringId - Specifies the ID of the custom security policy.
- sni
Container List<String>Refs - Lists the IDs of SNI certificates (server certificates with domain names) used by the listener.
Each SNI certificate can have up to 30 domain names, and each domain name in the SNI certificate must be unique.
This parameter will be ignored and an empty array will be returned if the listener's protocol is not
HTTPS
. - sni
Match StringAlgo - Specifies how wildcard domain name matches with the SNI certificates used by the listener.
- Map<String>
- Tags key/value pairs to associate with the loadbalancer listener.
- tls
Ciphers StringPolicy - Specifies the security policy that will be used by the listener.
This parameter is available only for
HTTPS
listeners. An error will be returned if the protocol of the listener is notHTTPS
. Possible values are:tls-1-0
,tls-1-1
,tls-1-0-inherit
,tls-1-2
,tls-1-2-strict
,tls-1-2-fs
,tls-1-0-with-1-3
,tls-1-2-fs-with-1-3
,hybrid-policy-1-0
,tls-1-2-strict-no-cbc
. - updated
At String - Indicates the update time.
Supporting Types
LbListenerV3InsertHeaders, LbListenerV3InsertHeadersArgs
- Forward
Elb boolIp - Specifies whether to transparently transmit the load balancer EIP
to backend servers. If
forward_elb_ip
is set totrue
, the load balancer EIP will be stored in the HTTP header and passed to backend servers. - Forwarded
For boolPort - Specifies whether to transparently transmit the source port of
the client to backend servers. If
forwarded_for_port
is set totrue
, the source port of the client will be stored in the HTTP header and passed to backend servers. - Forwarded
Host bool - Specifies whether to rewrite the
X-Forwarded-Host
header. Ifforwarded_host
is set totrue
,X-Forwarded-Host
in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers. - Forwarded
Port bool - Specifies whether to transparently transmit the listening port of
the load balancer to backend servers. If
forwarded_port
is set totrue
, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
- Forward
Elb boolIp - Specifies whether to transparently transmit the load balancer EIP
to backend servers. If
forward_elb_ip
is set totrue
, the load balancer EIP will be stored in the HTTP header and passed to backend servers. - Forwarded
For boolPort - Specifies whether to transparently transmit the source port of
the client to backend servers. If
forwarded_for_port
is set totrue
, the source port of the client will be stored in the HTTP header and passed to backend servers. - Forwarded
Host bool - Specifies whether to rewrite the
X-Forwarded-Host
header. Ifforwarded_host
is set totrue
,X-Forwarded-Host
in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers. - Forwarded
Port bool - Specifies whether to transparently transmit the listening port of
the load balancer to backend servers. If
forwarded_port
is set totrue
, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
- forward
Elb BooleanIp - Specifies whether to transparently transmit the load balancer EIP
to backend servers. If
forward_elb_ip
is set totrue
, the load balancer EIP will be stored in the HTTP header and passed to backend servers. - forwarded
For BooleanPort - Specifies whether to transparently transmit the source port of
the client to backend servers. If
forwarded_for_port
is set totrue
, the source port of the client will be stored in the HTTP header and passed to backend servers. - forwarded
Host Boolean - Specifies whether to rewrite the
X-Forwarded-Host
header. Ifforwarded_host
is set totrue
,X-Forwarded-Host
in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers. - forwarded
Port Boolean - Specifies whether to transparently transmit the listening port of
the load balancer to backend servers. If
forwarded_port
is set totrue
, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
- forward
Elb booleanIp - Specifies whether to transparently transmit the load balancer EIP
to backend servers. If
forward_elb_ip
is set totrue
, the load balancer EIP will be stored in the HTTP header and passed to backend servers. - forwarded
For booleanPort - Specifies whether to transparently transmit the source port of
the client to backend servers. If
forwarded_for_port
is set totrue
, the source port of the client will be stored in the HTTP header and passed to backend servers. - forwarded
Host boolean - Specifies whether to rewrite the
X-Forwarded-Host
header. Ifforwarded_host
is set totrue
,X-Forwarded-Host
in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers. - forwarded
Port boolean - Specifies whether to transparently transmit the listening port of
the load balancer to backend servers. If
forwarded_port
is set totrue
, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
- forward_
elb_ boolip - Specifies whether to transparently transmit the load balancer EIP
to backend servers. If
forward_elb_ip
is set totrue
, the load balancer EIP will be stored in the HTTP header and passed to backend servers. - forwarded_
for_ boolport - Specifies whether to transparently transmit the source port of
the client to backend servers. If
forwarded_for_port
is set totrue
, the source port of the client will be stored in the HTTP header and passed to backend servers. - forwarded_
host bool - Specifies whether to rewrite the
X-Forwarded-Host
header. Ifforwarded_host
is set totrue
,X-Forwarded-Host
in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers. - forwarded_
port bool - Specifies whether to transparently transmit the listening port of
the load balancer to backend servers. If
forwarded_port
is set totrue
, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
- forward
Elb BooleanIp - Specifies whether to transparently transmit the load balancer EIP
to backend servers. If
forward_elb_ip
is set totrue
, the load balancer EIP will be stored in the HTTP header and passed to backend servers. - forwarded
For BooleanPort - Specifies whether to transparently transmit the source port of
the client to backend servers. If
forwarded_for_port
is set totrue
, the source port of the client will be stored in the HTTP header and passed to backend servers. - forwarded
Host Boolean - Specifies whether to rewrite the
X-Forwarded-Host
header. Ifforwarded_host
is set totrue
,X-Forwarded-Host
in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers. - forwarded
Port Boolean - Specifies whether to transparently transmit the listening port of
the load balancer to backend servers. If
forwarded_port
is set totrue
, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
LbListenerV3IpGroup, LbListenerV3IpGroupArgs
- Id string
- Specifies the ID of the IP address group associated with the listener.
Specifies the ID of the IP address group associated with the listener.
If
ip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type towhitelist
, no IP addresses are allowed to access the listener. Ifip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type toblacklist
, any IP address is allowed to access the listener. - Enable bool
- Specifies whether to enable access control.
true
: Access control will be enabled.false
(default): Access control will be disabled. - Type string
- Specifies how access to the listener is controlled.
white
(default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener.black
: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
- Id string
- Specifies the ID of the IP address group associated with the listener.
Specifies the ID of the IP address group associated with the listener.
If
ip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type towhitelist
, no IP addresses are allowed to access the listener. Ifip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type toblacklist
, any IP address is allowed to access the listener. - Enable bool
- Specifies whether to enable access control.
true
: Access control will be enabled.false
(default): Access control will be disabled. - Type string
- Specifies how access to the listener is controlled.
white
(default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener.black
: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
- id String
- Specifies the ID of the IP address group associated with the listener.
Specifies the ID of the IP address group associated with the listener.
If
ip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type towhitelist
, no IP addresses are allowed to access the listener. Ifip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type toblacklist
, any IP address is allowed to access the listener. - enable Boolean
- Specifies whether to enable access control.
true
: Access control will be enabled.false
(default): Access control will be disabled. - type String
- Specifies how access to the listener is controlled.
white
(default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener.black
: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
- id string
- Specifies the ID of the IP address group associated with the listener.
Specifies the ID of the IP address group associated with the listener.
If
ip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type towhitelist
, no IP addresses are allowed to access the listener. Ifip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type toblacklist
, any IP address is allowed to access the listener. - enable boolean
- Specifies whether to enable access control.
true
: Access control will be enabled.false
(default): Access control will be disabled. - type string
- Specifies how access to the listener is controlled.
white
(default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener.black
: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
- id str
- Specifies the ID of the IP address group associated with the listener.
Specifies the ID of the IP address group associated with the listener.
If
ip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type towhitelist
, no IP addresses are allowed to access the listener. Ifip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type toblacklist
, any IP address is allowed to access the listener. - enable bool
- Specifies whether to enable access control.
true
: Access control will be enabled.false
(default): Access control will be disabled. - type str
- Specifies how access to the listener is controlled.
white
(default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener.black
: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
- id String
- Specifies the ID of the IP address group associated with the listener.
Specifies the ID of the IP address group associated with the listener.
If
ip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type towhitelist
, no IP addresses are allowed to access the listener. Ifip_list
inopentelekomcloud.LbIpgroupV3
is set to an empty array[]
and type toblacklist
, any IP address is allowed to access the listener. - enable Boolean
- Specifies whether to enable access control.
true
: Access control will be enabled.false
(default): Access control will be disabled. - type String
- Specifies how access to the listener is controlled.
white
(default): A whitelist will be configured. Only IP addresses in the whitelist can access the listener.black
: A blacklist will be configured. IP addresses in the blacklist are not allowed to access the listener.
Import
Listeners can be imported using the id
, e.g.
$ pulumi import opentelekomcloud:index/lbListenerV3:LbListenerV3 listener_1 7117d38e-4c8f-4624-a505-bd96b97d024c
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
- License
- Notes
- This Pulumi package is based on the
opentelekomcloud
Terraform Provider.